REFERENCE MANUAL
The OffScreenWindowOptionsKit class is a user space object. More...
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this OffScreenWindowOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.OffScreenWindowOptionsKit in_kit) |
Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
OffScreenWindowOptionsKit () | |
The default constructor creates an empty OffScreenWindowOptionsKit object. More... | |
OffScreenWindowOptionsKit (HPS.OffScreenWindowOptionsKit in_kit) | |
The copy constructor creates a new OffScreenWindowOptionsKit object that contains the same settings as the source OffScreenWindowOptionsKit. More... | |
void | Set (HPS.OffScreenWindowOptionsKit in_kit) |
Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetAntiAliasCapable (bool in_state, uint in_samples) |
Sets the anti-alias options for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetAntiAliasCapable (bool in_state) |
Sets the anti-alias options for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetDriver (HPS.Window.Driver in_driver) |
Sets the driver for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetHardwareResident (bool in_state) |
Sets whether the image data for this offscreen window should be stored exclusively in video memory. More... | |
HPS.OffScreenWindowOptionsKit | SetOpacity (bool in_state, float in_opacity) |
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background. More... | |
HPS.OffScreenWindowOptionsKit | SetOpacity (bool in_state) |
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background. More... | |
HPS.OffScreenWindowOptionsKit | SetOpacity (float in_opacity) |
Enables support for opacity in the window background and applies the specified opacity value when rendering the window background. More... | |
void | Show (out HPS.OffScreenWindowOptionsKit out_kit) |
Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit. More... | |
bool | ShowAntiAliasCapable (out bool out_state, out uint out_samples) |
Shows the anti-alias options for this OffScreenWindowOptionsKit. More... | |
bool | ShowDriver (out HPS.Window.Driver out_driver) |
Shows the driver for this OffScreenWindowOptionsKit. More... | |
bool | ShowHardwareResident (out bool out_state) |
Shows the hardware resident option for this OffScreenWindowOptionsKit. More... | |
bool | ShowOpacity (out bool out_state, out float out_opacity) |
Shows the opacity option for this offscreen window More... | |
HPS.OffScreenWindowOptionsKit | UnsetAntiAliasCapable () |
Removes the anti-alias options for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetDriver () |
Removes the driver for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetEverything () |
Removes all settings from this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetHardwareResident () |
Removes the hardware resident option for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetOpacity () |
Removes the opacity option for this OffScreenWindowOptionsKit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static HPS.OffScreenWindowOptionsKit | GetDefault () |
Creates an OffScreenWindowOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b) |
static bool | operator== (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The OffScreenWindowOptionsKit class is a user space object.
It is used to specify off-screen-window-specific options. Calling OffScreenWindowOptionsKit::GetDefault() will return an options kit with values found in this table.
HPS.OffScreenWindowOptionsKit.OffScreenWindowOptionsKit | ( | ) |
The default constructor creates an empty OffScreenWindowOptionsKit object.
HPS.OffScreenWindowOptionsKit.OffScreenWindowOptionsKit | ( | HPS.OffScreenWindowOptionsKit | in_kit | ) |
The copy constructor creates a new OffScreenWindowOptionsKit object that contains the same settings as the source OffScreenWindowOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this OffScreenWindowOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.OffScreenWindowOptionsKit.Equals | ( | HPS.OffScreenWindowOptionsKit | in_kit | ) |
Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref>. |
|
static |
Creates an OffScreenWindowOptionsKit which contains the default settings.
The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.OffScreenWindowOptionsKit.Set | ( | HPS.OffScreenWindowOptionsKit | in_kit | ) |
Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref> to copy. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetAntiAliasCapable | ( | bool | in_state, |
uint | in_samples | ||
) |
Sets the anti-alias options for this OffScreenWindowOptionsKit.
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. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetAntiAliasCapable | ( | bool | in_state | ) |
Sets the anti-alias options for this OffScreenWindowOptionsKit.
in_state | Whether the associated application window should be anti-alias capable. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetDriver | ( | HPS.Window.Driver | in_driver | ) |
Sets the driver for this OffScreenWindowOptionsKit.
in_driver | The driver for this <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref>. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetHardwareResident | ( | bool | in_state | ) |
Sets whether the image data for this offscreen window should be stored exclusively in video memory.
Storing the image in video memory improves the update time but may make the image data inaccessible directly.
in_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetOpacity | ( | bool | in_state, |
float | in_opacity | ||
) |
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.
in_state | Whether this offscreen window should support opacity in the window background. |
in_opacity | The opacity value that will be applied when rendering the window background. The value is clamped if the opacity is outside the range 0 to 1. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetOpacity | ( | bool | in_state | ) |
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.
in_state | Whether this offscreen window should support opacity in the window background. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetOpacity | ( | float | in_opacity | ) |
Enables support for opacity in the window background and applies the specified opacity value when rendering the window background.
in_opacity | The opacity value that will be applied when rendering the window background. |
void HPS.OffScreenWindowOptionsKit.Show | ( | out HPS.OffScreenWindowOptionsKit | out_kit | ) |
Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref>. |
bool HPS.OffScreenWindowOptionsKit.ShowAntiAliasCapable | ( | out bool | out_state, |
out uint | out_samples | ||
) |
Shows the anti-alias options for this OffScreenWindowOptionsKit.
out_state | Whether the associated application window should be anti-alias capable. |
out_samples | The number of anti-alias samples to use for the associated application window. |
bool HPS.OffScreenWindowOptionsKit.ShowDriver | ( | out HPS.Window.Driver | out_driver | ) |
Shows the driver for this OffScreenWindowOptionsKit.
out_driver | The driver for this <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref>. |
bool HPS.OffScreenWindowOptionsKit.ShowHardwareResident | ( | out bool | out_state | ) |
Shows the hardware resident option for this OffScreenWindowOptionsKit.
out_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
bool HPS.OffScreenWindowOptionsKit.ShowOpacity | ( | out bool | out_state, |
out float | out_opacity | ||
) |
Shows the opacity option for this offscreen window
out_state | The opacity value that will be applied when rendering the window background. |
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetAntiAliasCapable | ( | ) |
Removes the anti-alias options for this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetDriver | ( | ) |
Removes the driver for this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetHardwareResident | ( | ) |
Removes the hardware resident option for this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetOpacity | ( | ) |
Removes the opacity option for this OffScreenWindowOptionsKit.