The HPS::OffScreenWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query offscreen-window-specific options on an OffScreenWindowKey. This control also gives you the ability to make a screenshot of the Visualize scene using ShowImage. This table lists default values for the various segment attributes accessible from HPS::OffScreenWindowOptionsControl. More...
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
OffScreenWindowOptionsControl (HPS.OffScreenWindowKey in_seg) | |
This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window. More... | |
OffScreenWindowOptionsControl (HPS.OffScreenWindowOptionsControl in_that) | |
The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl. More... | |
HPS.OffScreenWindowOptionsControl | SetNativeFormat (HPS.Window.ImageFormat in_format, float in_quality) |
Sets the native image format to store data in. More... | |
HPS.OffScreenWindowOptionsControl | SetNativeFormat (HPS.Window.ImageFormat in_format) |
Sets the native image format to store data in. More... | |
HPS.OffScreenWindowOptionsControl | SetSize (uint in_width, uint in_height) |
Sets the width and height in pixels of the associated offscreen window. More... | |
bool | ShowAntiAliasCapable (out bool out_state, out uint out_samples) |
Shows the whether this offscreen window is anti-alias capable, and if so, how many samples it uses for anti-aliasing. More... | |
bool | ShowDriver (out HPS.Window.Driver out_driver) |
Shows the driver for the associated offscreen window. More... | |
bool | ShowHardwareResident (out bool out_state) |
Shows the hardware resident option of the associated offscreen window. More... | |
bool | ShowImage (HPS.Image.Format in_format, out HPS.ImageKit out_image) |
Shows the contents of this offscreen window into the provided ImageKit in the specified format. More... | |
bool | ShowImage (out byte[] out_bytes) |
Shows the image bytes in the native format for this OffScreenWindow. More... | |
bool | ShowNativeFormat (out HPS.Window.ImageFormat out_format, out float out_quality) |
Shows the native format and quality of the associated offscreen window. More... | |
bool | ShowOpacity (out bool out_state, out float out_opacity) |
Shows the opacity of the associated offscreen window More... | |
bool | ShowSize (out uint out_width, out uint out_height) |
Shows the width and height in pixels of the associated offscreen window. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The HPS::OffScreenWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query offscreen-window-specific options on an OffScreenWindowKey. This control also gives you the ability to make a screenshot of the Visualize scene using ShowImage. This table lists default values for the various segment attributes accessible from HPS::OffScreenWindowOptionsControl.
|
inline |
This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window.
|
inline |
The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl.
in_that | The source OffScreenWindowOptionsControl to copy. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
|
inline |
Sets the native image format to store data in.
in_format | Format image data will be stored in. |
in_quality | The compression quality for the image data (when applicable). |
|
inline |
Sets the native image format to store data in.
in_format | Format image data will be stored in. |
|
inline |
Sets the width and height in pixels of the associated offscreen window.
in_width | The width in pixels of the associated offscreen window. |
in_height | The height in pixels of the associated offscreen window. |
|
inline |
Shows the whether this offscreen window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.
out_state | Whether this offscreen window is anti-alias capable. |
out_samples | The number of anti-alias samples supported by this offscreen window. |
|
inline |
Shows the driver for the associated offscreen window.
out_driver | The driver for the associated offscreen window. |
|
inline |
Shows the hardware resident option of the associated offscreen window.
out_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
|
inline |
Shows the contents of this offscreen window into the provided ImageKit in the specified format.
in_format | The format of the image to generate. |
out_image | The contents of this offscreen window as an image in the specified format. |
|
inline |
Shows the image bytes in the native format for this OffScreenWindow.
out_bytes | Image data as an array of bytes. |
|
inline |
Shows the native format and quality of the associated offscreen window.
out_format | Format image data will be stored in. |
out_quality | The compression quality for the image data (when applicable). |
|
inline |
Shows the opacity of the associated offscreen window
out_state | Whether the offscreen window supports opacity in the window background. |
out_opacity | The opacity value that will be applied when rendering the window background. |
|
inline |
Shows the width and height in pixels of the associated offscreen window.
out_width | The width in pixels of the associated offscreen window. |
out_height | The height in pixels of the associated offscreen window. |