
Public Member Functions | |
override void | Dispose () |
override HPS.Type | ObjectType () |
HPS.StandAloneWindowOptionsControl | SetAntiAliasCapable (bool in_state, uint in_samples) |
Sets the anti-alias options for this StandAloneWindowOptionsControl. More... | |
HPS.StandAloneWindowOptionsControl | SetAntiAliasCapable (bool in_state) |
Sets the anti-alias options for this StandAloneWindowOptionsControl. More... | |
HPS.StandAloneWindowOptionsControl | 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.StandAloneWindowOptionsControl | SetFullScreen (bool in_state) |
Sets whether this stand-alone window should fill the screen. More... | |
HPS.StandAloneWindowOptionsControl | SetMobility (HPS.Window.Mobility in_mobility) |
Sets the mobility for this stand-alone window. Mobility refers to the resizing and positioning behaviors of a window. More... | |
HPS.StandAloneWindowOptionsControl | SetSubscreen (HPS.Rectangle in_subscreen) |
Sets the subscreen to render into for this stand-alone window. More... | |
bool | ShowAntiAliasCapable (out bool out_state, out uint out_samples) |
Shows the whether this stand-alone 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 this stand-alone 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 | ShowFullScreen (out bool out_state) |
Shows whether this stand-alone window should fill the screen. More... | |
bool | ShowMobility (out HPS.Window.Mobility out_mobility) |
Shows the mobility for this stand-alone window. More... | |
bool | ShowSubscreen (out HPS.Rectangle out_subscreen) |
Shows the subscreen for this stand-alone window. More... | |
bool | ShowTitle (out string out_window_name) |
Shows the title for this stand-alone window. More... | |
bool | ShowWindowHandle (out IntPtr out_window_handle) |
Shows the window handle for the associated standalone window. More... | |
StandAloneWindowOptionsControl (HPS.StandAloneWindowKey in_seg) | |
This constructor creates a StandAloneWindowOptionsControl object which is tied to the specified offscreen window. More... | |
StandAloneWindowOptionsControl (HPS.StandAloneWindowOptionsControl in_that) | |
The copy constructor creates a StandAloneWindowOptionsControl object that shares the underlying smart-pointer of the source StandAloneWindowOptionsControl. 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.StandAloneWindowOptionsControl | UnsetFallbackFonts () |
Unsets any fonts currently used as fallback fonts. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.StandAloneWindowOptionsControl class is a smart pointer that is tied to a database object. It is used to set and query stand-alone-window-specific options on a HPS.StandAloneWindowKey.
Default values for the various fields of HPS.StandAloneWindowOptionsControl can be found here.
Constructor & Destructor Documentation
|
inline |
This constructor creates a StandAloneWindowOptionsControl object which is tied to the specified offscreen window.
|
inline |
The copy constructor creates a StandAloneWindowOptionsControl object that shares the underlying smart-pointer of the source StandAloneWindowOptionsControl.
- Parameters
-
in_that The source StandAloneWindowOptionsControl to copy.
Member Function Documentation
|
inline |
Sets the anti-alias options for this StandAloneWindowOptionsControl.
- Parameters
-
in_state Whether the associated stand-alone window should be anti-alias capable. in_samples The number of anti-alias samples to use for the associated stand-alone window. Defaults to 4.
- Returns
- A reference to this StandAloneWindowOptionsControl.
|
inline |
Sets the anti-alias options for this StandAloneWindowOptionsControl.
- Parameters
-
in_state Whether the associated stand-alone window should be anti-alias capable.
- Returns
- A reference to this StandAloneWindowOptionsControl.
|
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.
|
inline |
Sets whether this stand-alone window should fill the screen.
- Parameters
-
in_state Whether this stand-alone window should fill the screen.
- Returns
- A reference to this StandAloneWindowOptionsControl.
|
inline |
Sets the mobility for this stand-alone window. Mobility refers to the resizing and positioning behaviors of a window.
- Parameters
-
in_mobility The mobility for this stand-alone window.
- Returns
- A reference to this StandAloneWindowOptionsControl.
|
inline |
Sets the subscreen to render into for this stand-alone window.
- Parameters
-
in_subscreen The subscreen to render into for this stand-alone window. The units of the Rectangle are in window space, so -1.0f corresponds to the left (or bottom) of the window and 1.0f corresponds to the right (or top) of the window.
- Returns
- A reference to this StandAloneWindowOptionsControl.
|
inline |
Shows the whether this stand-alone window is anti-alias capable, and if so, how many samples it uses for anti-aliasing.
- Parameters
-
out_state Whether this stand-alone window is anti-alias capable. out_samples The number of anti-alias samples supported by this stand-alone window.
- Returns
- true if any anti-alias options were set, false otherwise.
|
inline |
Shows the driver for this stand-alone window.
- Parameters
-
out_driver The driver for this stand-alone window.
- Returns
- true if a driver was set, false otherwise.
|
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.
|
inline |
Shows whether this stand-alone window should fill the screen.
- Parameters
-
out_state Whether this stand-alone window should fill the screen.
- Returns
- true if a full screen flag was set, false otherwise.
|
inline |
Shows the mobility for this stand-alone window.
- Parameters
-
out_mobility The mobility for this stand-alone window.
- Returns
- true if a mobility was set, false otherwise.
|
inline |
Shows the subscreen for this stand-alone window.
- Parameters
-
out_subscreen The subscreen for this stand-alone window.
- Returns
- true if a subscreen was set, false otherwise.
|
inline |
Shows the title for this stand-alone window.
- Parameters
-
out_window_name UTF8-encoded title for this stand-alone window.
- Returns
- true if a title was set, false otherwise.
|
inline |
Shows the window handle for the associated standalone window.
- Parameters
-
out_window_handle The window handle for the associated standalone window.
- Returns
- true if a window handle is available, false otherwise.
|
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.
|
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.StandAloneWindowOptionsControl.cs