|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
Standalone windows are not supported on Android, iOS, or macOS as all GUI / windowing is controlled at the application level.
◆ StandAloneWindowOptionsControl() [1/2]
◆ StandAloneWindowOptionsControl() [2/2]
◆ ObjectType()
override HPS.Type HPS.StandAloneWindowOptionsControl.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 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.
◆ SetAntiAliasCapable() [2/2]
◆ SetFullScreen()
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.
◆ SetMobility()
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.
◆ SetScreenAntiAliasing()
Manipulates the state of screen anti-aliasing.
- Parameters
-
in_state | Whether screen anti-aliasing should be used. |
- Returns
- A reference to this object.
◆ SetSubscreen()
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.
◆ ShowAntiAliasCapable()
bool HPS.StandAloneWindowOptionsControl.ShowAntiAliasCapable |
( |
out bool |
out_state, |
|
|
out uint |
out_samples |
|
) |
| |
|
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.
◆ ShowDriver()
bool HPS.StandAloneWindowOptionsControl.ShowDriver |
( |
out HPS.Window.Driver |
out_driver | ) |
|
|
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.
◆ ShowFullScreen()
bool HPS.StandAloneWindowOptionsControl.ShowFullScreen |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowMobility()
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.
◆ ShowSubscreen()
bool HPS.StandAloneWindowOptionsControl.ShowSubscreen |
( |
out HPS.Rectangle |
out_subscreen | ) |
|
|
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.
◆ ShowTitle()
bool HPS.StandAloneWindowOptionsControl.ShowTitle |
( |
out string |
out_window_name | ) |
|
|
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.
◆ ShowWindowHandle()
bool HPS.StandAloneWindowOptionsControl.ShowWindowHandle |
( |
out IntPtr |
out_window_handle | ) |
|
|
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.
◆ Type()
override HPS.Type HPS.StandAloneWindowOptionsControl.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()
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