|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ OffScreenWindowOptionsControl() [1/2]
◆ OffScreenWindowOptionsControl() [2/2]
◆ ObjectType()
override HPS.Type HPS.OffScreenWindowOptionsControl.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Control.
◆ SetAntiAliasCapable() [1/2]
Sets the anti-alias options for this OffScreenWindowOptionsControl.
- Parameters
-
in_state | Whether the associated off-screen window should be anti-alias capable. |
in_samples | The number of anti-alias samples to use for the associated off-screen window. Defaults to 4. |
- Returns
- A reference to this OffScreenWindowOptionsControl.
◆ SetAntiAliasCapable() [2/2]
◆ SetFallbackFonts()
Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font.
- Parameters
-
in_fonts | An array of UTF8 encoded strings that correspond to the fallback fonts being used. |
◆ SetNativeFormat() [1/2]
Sets the native image format to store data in.
- Parameters
-
in_format | Format image data will be stored in. |
in_quality | The compression quality for the image data (when applicable). |
- Returns
- A reference to this OffScreenWindowOptionsControl.
◆ SetNativeFormat() [2/2]
Sets the native image format to store data in.
- Parameters
-
in_format | Format image data will be stored in. |
- Returns
- A reference to this OffScreenWindowOptionsControl.
◆ SetScreenAntiAliasing()
Manipulates the state of screen anti-aliasing.
- Parameters
-
in_state | Whether screen anti-aliasing should be used. |
- Returns
- A reference to this object.
◆ SetSize()
Sets the width and height in pixels of the associated offscreen window.
- Parameters
-
in_width | The width in pixels of the associated offscreen window. |
in_height | The height in pixels of the associated offscreen window. |
- Returns
- A reference to this OffScreenWindowOptionsControl.
◆ ShowAntiAliasCapable()
bool HPS.OffScreenWindowOptionsControl.ShowAntiAliasCapable |
( |
out bool |
out_state, |
|
|
out uint |
out_samples |
|
) |
| |
|
inline |
Shows the whether this offscreen window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.
- Parameters
-
out_state | Whether this offscreen window is anti-alias capable. |
out_samples | The number of anti-alias samples supported by this offscreen window. |
- Returns
- true if any anti-alias options were set, false otherwise.
◆ ShowDriver()
bool HPS.OffScreenWindowOptionsControl.ShowDriver |
( |
out HPS.Window.Driver |
out_driver | ) |
|
|
inline |
Shows the driver for the associated offscreen window.
- Parameters
-
out_driver | The driver for the associated offscreen window. |
- Returns
- true if a driver was set, false otherwise.
◆ ShowFallbackFonts()
ulong HPS.OffScreenWindowOptionsControl.ShowFallbackFonts |
( |
out string [] |
out_fonts | ) |
|
|
inline |
Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font.
- Parameters
-
out_fonts | An array of UTF8 encoded strings that correspond to the fallback fonts being used. |
◆ ShowFramebufferRetention()
bool HPS.OffScreenWindowOptionsControl.ShowFramebufferRetention |
( |
out bool |
out_retain | ) |
|
|
inline |
Shows the framebuffer retention setting for the associated offscreen window.
- Parameters
-
out_retain | The framebuffer retention setting for the associated offscreen window. |
- Returns
- true if framebuffer retention option was set, false otherwise.
◆ ShowHardwareResident()
bool HPS.OffScreenWindowOptionsControl.ShowHardwareResident |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the hardware resident option of the associated offscreen window.
- Parameters
-
out_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
- Returns
- true if a hardware resident option was set, false otherwise.
◆ ShowImage() [1/2]
Shows the contents of this offscreen window into the provided ImageKit in the specified format.
- Parameters
-
in_format | The format of the image to generate. |
out_image | The contents of this offscreen window as an image in the specified format. |
- Returns
- true if the shown image is valid, false otherwise.
◆ ShowImage() [2/2]
bool HPS.OffScreenWindowOptionsControl.ShowImage |
( |
out byte [] |
out_bytes | ) |
|
|
inline |
Shows the image bytes in the native format for this OffScreenWindow.
- Parameters
-
out_bytes | Image data as an array of bytes. |
- Returns
- true if the shown image is valid, false otherwise.
◆ ShowNativeFormat()
bool HPS.OffScreenWindowOptionsControl.ShowNativeFormat |
( |
out HPS.Window.ImageFormat |
out_format, |
|
|
out float |
out_quality |
|
) |
| |
|
inline |
Shows the native format and quality of the associated offscreen window.
- Parameters
-
out_format | Format image data will be stored in. |
out_quality | The compression quality for the image data (when applicable). |
- Returns
- true if a native format option was set, false otherwise.
◆ ShowOpacity()
bool HPS.OffScreenWindowOptionsControl.ShowOpacity |
( |
out bool |
out_state, |
|
|
out float |
out_opacity |
|
) |
| |
|
inline |
Shows the opacity of the associated offscreen window
- Parameters
-
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. |
- Returns
- true if an opacity option was set, false otherwise.
◆ ShowSize()
bool HPS.OffScreenWindowOptionsControl.ShowSize |
( |
out uint |
out_width, |
|
|
out uint |
out_height |
|
) |
| |
|
inline |
Shows the width and height in pixels of the associated offscreen window.
- Parameters
-
out_width | The width in pixels of the associated offscreen window. |
out_height | The height in pixels of the associated offscreen window. |
- Returns
- true if a height and width were set, false otherwise.
◆ Type()
override HPS.Type HPS.OffScreenWindowOptionsControl.Type |
( |
| ) |
|
|
inlinevirtual |
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
◆ UnsetFallbackFonts()
Unsets any fonts currently used as fallback fonts.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.OffScreenWindowOptionsControl.cs