
Public Member Functions | |
ApplicationWindowOptionsControl (HPS.ApplicationWindowKey in_seg) | |
This constructor creates a ApplicationWindowOptionsControl object which is tied to the specified offscreen window. More... | |
ApplicationWindowOptionsControl (HPS.ApplicationWindowOptionsControl in_that) | |
The copy constructor creates a ApplicationWindowOptionsControl object that shares the underlying smart-pointer of the source ApplicationWindowOptionsControl. More... | |
override void | Dispose () |
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). More... | |
HPS.ApplicationWindowOptionsControl | SetAntiAliasCapable (bool in_state, uint in_samples) |
Sets the anti-alias options for this ApplicationWindowOptionsControl. More... | |
HPS.ApplicationWindowOptionsControl | SetAntiAliasCapable (bool in_state) |
Sets the anti-alias options for this ApplicationWindowOptionsControl. More... | |
HPS.ApplicationWindowOptionsControl | SetFallbackFonts (string[] in_fonts) |
Supplies an array of fonts to be used as fallbacks for when a character can not be found in the active font. More... | |
HPS.ApplicationWindowOptionsControl | SetPlatformData (IntPtr in_platform_data) |
Sets the platform specific data for the associated application window. More... | |
HPS.ApplicationWindowOptionsControl | SetScreenAntiAliasing (bool in_state) |
Manipulates the state of screen anti-aliasing. More... | |
HPS.ApplicationWindowOptionsControl | SetWindowHandle (IntPtr in_window_handle) |
Sets the window handle for the associated application window. Used to rebind the application window to a new window handle. More... | |
bool | ShowAntiAliasCapable (out bool out_state, out uint out_samples) |
Shows the whether this application 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 application window. More... | |
ulong | ShowFallbackFonts (out string[] out_fonts) |
Returns an array of fonts set to be used as fallbacks for when a character can not be found in the active font. More... | |
bool | ShowFramebufferRetention (out bool out_retain) |
Shows the framebuffer retention setting for the associated application window. More... | |
bool | ShowPlatformData (out IntPtr out_platform_data) |
Shows the platform specific data for the associated application window. More... | |
bool | ShowWindowHandle (out IntPtr out_window_handle) |
Shows the window handle for the associated application window. More... | |
override 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... | |
HPS.ApplicationWindowOptionsControl | UnsetFallbackFonts () |
Unsets any fonts currently used as fallback fonts. More... | |
![]() | |
Control (HPS.Control in_that) | |
override void | Dispose () |
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). More... | |
override 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... | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.ApplicationWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to query and manipulate options pertaining to an HPS.ApplicationWindowKey. Default values for the various fields of HPS.ApplicationWindowOptionsControl can be found here.
Constructor & Destructor Documentation
◆ ApplicationWindowOptionsControl() [1/2]
|
inline |
This constructor creates a ApplicationWindowOptionsControl object which is tied to the specified offscreen window.
◆ ApplicationWindowOptionsControl() [2/2]
|
inline |
The copy constructor creates a ApplicationWindowOptionsControl object that shares the underlying smart-pointer of the source ApplicationWindowOptionsControl.
- Parameters
-
in_that The source ApplicationWindowOptionsControl to copy.
Member Function Documentation
◆ 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.Object.
◆ SetAntiAliasCapable() [1/2]
|
inline |
Sets the anti-alias options for this ApplicationWindowOptionsControl.
- Parameters
-
in_state Whether the associated application window should be anti-alias capable. in_samples The number of anti-alias samples to use for the associated application window. Defaults to 4.
- Returns
- A reference to this StandAloneWindowOptionsKit.
◆ SetAntiAliasCapable() [2/2]
|
inline |
Sets the anti-alias options for this ApplicationWindowOptionsControl.
- Parameters
-
in_state Whether the associated application window should be anti-alias capable.
- Returns
- A reference to this StandAloneWindowOptionsKit.
◆ SetFallbackFonts()
|
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_fonts An array of UTF8 encoded strings that correspond to the fallback fonts being used.
◆ SetPlatformData()
|
inline |
Sets the platform specific data for the associated application window.
- Parameters
-
in_platform_data Platform specific data for the associated application window.
- Returns
- A reference to this ApplicationWindowOptionsControl.
◆ SetScreenAntiAliasing()
|
inline |
Manipulates the state of screen anti-aliasing.
- Parameters
-
in_state Whether screen anti-aliasing should be used.
- Returns
- A reference to this object.
◆ SetWindowHandle()
|
inline |
Sets the window handle for the associated application window. Used to rebind the application window to a new window handle.
- Parameters
-
in_window_handle Handle to the new WindowHandle that Visualize will draw into.
- Returns
- A reference to this ApplicationWindowOptionsControl.
◆ ShowAntiAliasCapable()
|
inline |
Shows the whether this application window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.
- Parameters
-
out_state Whether this application window is anti-alias capable. out_samples The number of anti-alias samples supported by this application window.
- Returns
- true if any anti-alias options were set, false otherwise.
◆ ShowDriver()
|
inline |
Shows the driver for the associated application window.
- Parameters
-
out_driver The driver for the associated application window.
- Returns
- true if a driver was set, false otherwise.
◆ ShowFallbackFonts()
|
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()
|
inline |
Shows the framebuffer retention setting for the associated application window.
- Parameters
-
out_retain The framebuffer retention setting for the associated application window.
- Returns
- true if framebuffer retention option was set, false otherwise.
◆ ShowPlatformData()
|
inline |
Shows the platform specific data for the associated application window.
- Parameters
-
out_platform_data The platform specific data for the associated application window.
- Returns
- true if platform specific data was set, false otherwise.
◆ ShowWindowHandle()
|
inline |
Shows the window handle for the associated application window.
- Parameters
-
out_window_handle The window handle for the associated application window.
- Returns
- true if a window handle was set, false otherwise.
◆ 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.Object.
◆ 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.ApplicationWindowOptionsControl.cs