HPS.OffScreenWindowOptionsControl Class Reference
Inheritance diagram for HPS.OffScreenWindowOptionsControl:
HPS.Control HPS.Object

Public Member Functions

override void Dispose ()
 
override HPS.Type ObjectType ()
 
 OffScreenWindowOptionsControl (HPS.OffScreenWindowKey in_seg)
 
 OffScreenWindowOptionsControl (HPS.OffScreenWindowOptionsControl in_that)
 
HPS.OffScreenWindowOptionsControl SetAntiAliasCapable (bool in_state, uint in_samples)
 
HPS.OffScreenWindowOptionsControl SetAntiAliasCapable (bool in_state)
 
HPS.OffScreenWindowOptionsControl SetFallbackFonts (string[] in_fonts)
 
HPS.OffScreenWindowOptionsControl SetNativeFormat (HPS.Window.ImageFormat in_format, float in_quality)
 
HPS.OffScreenWindowOptionsControl SetNativeFormat (HPS.Window.ImageFormat in_format)
 
HPS.OffScreenWindowOptionsControl SetScreenAntiAliasing (bool in_state)
 
HPS.OffScreenWindowOptionsControl SetSize (uint in_width, uint in_height)
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 
ulong ShowFallbackFonts (out string[] out_fonts)
 
bool ShowFramebufferRetention (out bool out_retain)
 
bool ShowHardwareResident (out bool out_state)
 
bool ShowImage (HPS.Image.Format in_format, out HPS.ImageKit out_image)
 
bool ShowImage (out byte[] out_bytes)
 
bool ShowNativeFormat (out HPS.Window.ImageFormat out_format, out float out_quality)
 
bool ShowOpacity (out bool out_state, out float out_opacity)
 
bool ShowSize (out uint out_width, out uint out_height)
 
override HPS.Type Type ()
 
HPS.OffScreenWindowOptionsControl UnsetFallbackFonts ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ OffScreenWindowOptionsControl() [1/2]

HPS.OffScreenWindowOptionsControl.OffScreenWindowOptionsControl ( HPS.OffScreenWindowKey  in_seg)
inline

This constructor creates a OffScreenWindowOptionsControl object which is tied to the specified offscreen window.

◆ OffScreenWindowOptionsControl() [2/2]

HPS.OffScreenWindowOptionsControl.OffScreenWindowOptionsControl ( HPS.OffScreenWindowOptionsControl  in_that)
inline

The copy constructor creates a OffScreenWindowOptionsControl object that shares the underlying smart-pointer of the source OffScreenWindowOptionsControl.

Parameters
in_thatThe source OffScreenWindowOptionsControl to copy.

Member Function Documentation

◆ 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]

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetAntiAliasCapable ( bool  in_state,
uint  in_samples 
)
inline

Sets the anti-alias options for this OffScreenWindowOptionsControl.

Parameters
in_stateWhether the associated off-screen window should be anti-alias capable.
in_samplesThe 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]

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetAntiAliasCapable ( bool  in_state)
inline

Sets the anti-alias options for this OffScreenWindowOptionsControl.

Parameters
in_stateWhether the associated off-screen window should be anti-alias capable.
Returns
A reference to this OffScreenWindowOptionsControl.

◆ SetFallbackFonts()

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetFallbackFonts ( string []  in_fonts)
inline

Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font.

Parameters
in_fontsAn array of UTF8 encoded strings that correspond to the fallback fonts being used.

◆ SetNativeFormat() [1/2]

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetNativeFormat ( HPS.Window.ImageFormat  in_format,
float  in_quality 
)
inline

Sets the native image format to store data in.

Parameters
in_formatFormat image data will be stored in.
in_qualityThe compression quality for the image data (when applicable).
Returns
A reference to this OffScreenWindowOptionsControl.

◆ SetNativeFormat() [2/2]

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetNativeFormat ( HPS.Window.ImageFormat  in_format)
inline

Sets the native image format to store data in.

Parameters
in_formatFormat image data will be stored in.
Returns
A reference to this OffScreenWindowOptionsControl.

◆ SetScreenAntiAliasing()

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetScreenAntiAliasing ( bool  in_state)
inline

Manipulates the state of screen anti-aliasing.

Parameters
in_stateWhether screen anti-aliasing should be used.
Returns
A reference to this object.

◆ SetSize()

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.SetSize ( uint  in_width,
uint  in_height 
)
inline

Sets the width and height in pixels of the associated offscreen window.

Parameters
in_widthThe width in pixels of the associated offscreen window.
in_heightThe 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_stateWhether this offscreen window is anti-alias capable.
out_samplesThe 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_driverThe 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_fontsAn 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_retainThe 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_stateWhether 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]

bool HPS.OffScreenWindowOptionsControl.ShowImage ( HPS.Image.Format  in_format,
out HPS.ImageKit  out_image 
)
inline

Shows the contents of this offscreen window into the provided ImageKit in the specified format.

Parameters
in_formatThe format of the image to generate.
out_imageThe 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_bytesImage 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_formatFormat image data will be stored in.
out_qualityThe 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_stateWhether the offscreen window supports opacity in the window background.
out_opacityThe 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_widthThe width in pixels of the associated offscreen window.
out_heightThe 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.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS.Control.

◆ UnsetFallbackFonts()

HPS.OffScreenWindowOptionsControl HPS.OffScreenWindowOptionsControl.UnsetFallbackFonts ( )
inline

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