HPS.OffScreenWindowOptionsControl
- class HPS.OffScreenWindowOptionsControl : public HPS.Control
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.
Public Functions
- override HPS.Type ObjectType ()
This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- OffScreenWindowOptionsControl (HPS.OffScreenWindowKey in_seg)
This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window.
- OffScreenWindowOptionsControl (HPS.OffScreenWindowOptionsControl in_that)
The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl.
- Param in_that
The source OffScreenWindowOptionsControl to copy.
- HPS.OffScreenWindowOptionsControl SetAntiAliasCapable (bool in_state)
Sets the anti-alias options for this OffScreenWindowOptionsControl.
- Param in_state
Whether the associated off-screen window should be anti-alias capable.
- Return
A reference to this OffScreenWindowOptionsControl.
- HPS.OffScreenWindowOptionsControl SetAntiAliasCapable (bool in_state, uint in_samples)
Sets the anti-alias options for this OffScreenWindowOptionsControl.
- Param in_state
Whether the associated off-screen window should be anti-alias capable.
- Param in_samples
The number of anti-alias samples to use for the associated off-screen window. Defaults to 4.
- Return
A reference to this OffScreenWindowOptionsControl.
- HPS.OffScreenWindowOptionsControl SetNativeFormat (HPS.Window.ImageFormat in_format)
Sets the native image format to store data in.
- Param in_format
Format image data will be stored in.
- Return
A reference to this OffScreenWindowOptionsControl.
- HPS.OffScreenWindowOptionsControl SetNativeFormat (HPS.Window.ImageFormat in_format, float in_quality)
Sets the native image format to store data in.
- Param in_format
Format image data will be stored in.
- Param in_quality
The compression quality for the image data (when applicable).
- Return
A reference to this OffScreenWindowOptionsControl.
- HPS.OffScreenWindowOptionsControl SetScreenAntiAliasing (bool in_state)
Manipulates the state of screen anti-aliasing.
- Param in_state
Whether screen anti-aliasing should be used.
- Return
A reference to this object.
- HPS.OffScreenWindowOptionsControl SetSize (uint in_width, uint in_height)
Sets the width and height in pixels of the associated offscreen window.
- Param in_width
The width in pixels of the associated offscreen window.
- Param in_height
The height in pixels of the associated offscreen window.
- Return
A reference to this OffScreenWindowOptionsControl.
- 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.
- Param out_state
Whether this offscreen window is anti-alias capable.
- Param out_samples
The number of anti-alias samples supported by this offscreen window.
- Return
true if any anti-alias options were set, false otherwise.
- bool ShowDriver (out HPS.Window.Driver out_driver)
Shows the driver for the associated offscreen window.
- Param out_driver
The driver for the associated offscreen window.
- Return
true if a driver was set, false otherwise.
- bool ShowFramebufferRetention (out bool out_retain)
Shows the framebuffer retention setting for the associated offscreen window.
- Param out_retain
The framebuffer retention setting for the associated offscreen window.
- Return
true if framebuffer retention option was set, false otherwise.
- bool ShowHardwareResident (out bool out_state)
Shows the hardware resident option of the associated offscreen window.
- Param out_state
Whether the image data for this offscreen window should be stored exclusively in video memory.
- Return
true if a hardware resident option was set, false otherwise.
- 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.
- Param in_format
The format of the image to generate.
- Param out_image
The contents of this offscreen window as an image in the specified format.
- Return
true if the shown image is valid, false otherwise.
- bool ShowImage (out byte[] out_bytes)
Shows the image bytes in the native format for this OffScreenWindow.
- Param out_bytes
Image data as an array of bytes.
- Return
true if the shown image is valid, false otherwise.
- bool ShowNativeFormat (out HPS.Window.ImageFormat out_format, out float out_quality)
Shows the native format and quality of the associated offscreen window.
- Param out_format
Format image data will be stored in.
- Param out_quality
The compression quality for the image data (when applicable).
- Return
true if a native format option was set, false otherwise.
- bool ShowOpacity (out bool out_state, out float out_opacity)
Shows the opacity of the associated offscreen window
- Param out_state
Whether the offscreen window supports opacity in the window background.
- Param out_opacity
The opacity value that will be applied when rendering the window background.
- Return
true if an opacity option was set, false otherwise.
- bool ShowSize (out uint out_width, out uint out_height)
Shows the width and height in pixels of the associated offscreen window.
- Param out_width
The width in pixels of the associated offscreen window.
- Param out_height
The height in pixels of the associated offscreen window.
- Return
true if a height and width were set, false otherwise.
- HPS.OffScreenWindowOptionsControl UnsetFallbackFonts ()
Unsets any fonts currently used as fallback fonts.