OGLGetScaledCtrlBitmap
int OGLGetScaledCtrlBitmap (int panelHandle, int OGLControlId, int maximumSize, int newWidth, int newHeight, int *bitmapId);
Purpose
Gets a scaled bitmap of the OGL control.
 |
Note Using the maximum size option results in a request for a large amount of memory. For example, if the maximum sized bitmap happens to be 2000 × 2000 pixels, then the amount of memory requested will be 2000 × 2000 × 3 bytes, which is approximately 12MB of memory. |
Parameters
| Input | ||||
| Name | Type | Description | ||
| panelHandle | int | The specifier for a particular panel that is currently in memory. This handle will have been returned by the LoadPanel, NewPanel, or DuplicatePanel function. |
||
| OGLControlId | int | The ID returned by OGLNewCtrl or OGLConvertCtrl. | ||
| maximumSize | int | Specify a nonzero value or select Yes in the function panel to scale the bitmap to the maximum possible resolution based on the currently selected printer. The newWidth and newHeight parameters are ignored if you enable maximum size. Specify 0 or select No in the function panel to disable using the maximum size.
|
||
| newWidth | int | Specifies the desired width of the resultant bitmap. Use –1 to maintain the same width. |
||
| newHeight | int | Specifies the desired height of the resultant bitmap. Use –1 to maintain the same height. |
||
| Output | ||||
| Name | Type | Description | ||
| bitmapId | int | An ID that represents the bitmap created from the current appearance of the control. It can be passed to CanvasDrawBitmap, ClipboardPutBitmap, or any other function that accepts a bitmap. You can discard the bitmap by passing the ID to the DiscardBitmap function. Zero is not a valid bitmap ID. |
||
Return Value
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| status | int | Return value indicating whether the function was successful. A negative number indicates that an error occurred.Error Codes
|
Additional Information
Library: OpenGL 3D Plotting Control
Include file: custctrl\cviogl.h
LabWindows/CVI compatibility: LabWindows/CVI 5.0 and later