OGLCopyScaledCtrlBitmap
int OGLCopyScaledCtrlBitmap (int panelHandle, int OGLControlId, int maximumSize, int newWidth, int newHeight, int destinationPanelHandle, int destinationControlId);
Purpose
Copies a scaled bitmap of the OGL control into the specified LabWindows/CVI control.
![]() |
Note Using the maximum size option results in a request for a large amount of memory. For example, if the maximum sized bitmap is 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.
|
||
destinationPanelHandle | int | Specifies the destination panel on which the control into which the bitmap will be copied resides. Use –1 if the control resides on the same panel as the OGL control. |
||
destinationControlId | int | Specifies the destination control into which the bitmap will be copied. Use –1 if the control is the parent control from which the OGL control is created. In this case, the destination panel must be specified as –1 or as the panel on which the OGL control resides. |
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