REFERENCE MANUAL
The ApplicationWindowOptionsKit class is a user space object. More...
Public Member Functions | |
ApplicationWindowOptionsKit () | |
The default constructor creates an empty ApplicationWindowOptionsKit object. More... | |
ApplicationWindowOptionsKit (HPS.ApplicationWindowOptionsKit in_kit) | |
The copy constructor creates a new ApplicationWindowOptionsKit object that contains the same settings as the source ApplicationWindowOptionsKit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ApplicationWindowOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ApplicationWindowOptionsKit in_kit) |
Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.ApplicationWindowOptionsKit in_kit) |
Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | SetAntiAliasCapable (bool in_state, uint in_samples) |
Sets the anti-alias options for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | SetAntiAliasCapable (bool in_state) |
Sets the anti-alias options for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | SetDriver (HPS.Window.Driver in_driver) |
Sets the driver for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | SetFramebufferRetention (bool in_retain) |
Sets the framebuffer retention option for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | SetPlatformData (IntPtr in_platform_data) |
Sets the platform specific data for this ApplicationWindowOptionsKit. More... | |
void | Show (out HPS.ApplicationWindowOptionsKit out_kit) |
Copies this ApplicationWindowOptionsKit into the given ApplicationWindowOptionsKit. More... | |
bool | ShowAntiAliasCapable (out bool out_state, out uint out_samples) |
Shows the anti-alias options for this ApplicationWindowOptionsKit. More... | |
bool | ShowDriver (out HPS.Window.Driver out_driver) |
Shows the driver for this ApplicationWindowOptionsKit. More... | |
bool | ShowFramebufferRetention (out bool out_retain) |
Shows the framebuffer retention setting for this ApplicationWindowOptionsKit. More... | |
bool | ShowPlatformData (out IntPtr out_platform_data) |
Shows the platform specific data for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | UnsetAntiAliasCapable () |
Removes the anti-alias options for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | UnsetDriver () |
Removes the driver for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | UnsetEverything () |
Removes all settings from this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | UnsetFramebufferRetention () |
Removes the framebuffer retention setting for this ApplicationWindowOptionsKit. More... | |
HPS.ApplicationWindowOptionsKit | UnsetPlatformData () |
Removes the platform specific data for this ApplicationWindowOptionsKit. 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.ApplicationWindowOptionsKit | GetDefault () |
Creates an ApplicationWindowOptionsKit which contains the default settings. More... | |
static bool | operator!= (HPS.ApplicationWindowOptionsKit a, HPS.ApplicationWindowOptionsKit b) |
static bool | operator== (HPS.ApplicationWindowOptionsKit a, HPS.ApplicationWindowOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ApplicationWindowOptionsKit class is a user space object.
It is used to specify application-window-specific options. Calling ApplicationWindowOptionsKit::GetDefault() will return a kit with values found in this table.
HPS.ApplicationWindowOptionsKit.ApplicationWindowOptionsKit | ( | ) |
The default constructor creates an empty ApplicationWindowOptionsKit object.
HPS.ApplicationWindowOptionsKit.ApplicationWindowOptionsKit | ( | HPS.ApplicationWindowOptionsKit | in_kit | ) |
The copy constructor creates a new ApplicationWindowOptionsKit object that contains the same settings as the source ApplicationWindowOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref> to copy. |
|
virtual |
Indicates whether this ApplicationWindowOptionsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.ApplicationWindowOptionsKit.Equals | ( | HPS.ApplicationWindowOptionsKit | in_kit | ) |
Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref>. |
|
static |
Creates an ApplicationWindowOptionsKit 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.ApplicationWindowOptionsKit.Set | ( | HPS.ApplicationWindowOptionsKit | in_kit | ) |
Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref> to copy. |
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.SetAntiAliasCapable | ( | bool | in_state, |
uint | in_samples | ||
) |
Sets the anti-alias options for this ApplicationWindowOptionsKit.
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. |
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.SetAntiAliasCapable | ( | bool | in_state | ) |
Sets the anti-alias options for this ApplicationWindowOptionsKit.
in_state | Whether the associated application window should be anti-alias capable. |
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.SetDriver | ( | HPS.Window.Driver | in_driver | ) |
Sets the driver for this ApplicationWindowOptionsKit.
in_driver | The driver for this <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref>. |
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.SetFramebufferRetention | ( | bool | in_retain | ) |
Sets the framebuffer retention option for this ApplicationWindowOptionsKit.
in_retain | Whether the associated application window retains the image from the previous frame. |
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.SetPlatformData | ( | IntPtr | in_platform_data | ) |
Sets the platform specific data for this ApplicationWindowOptionsKit.
in_platform_data | Platform specific data for this <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref>. |
void HPS.ApplicationWindowOptionsKit.Show | ( | out HPS.ApplicationWindowOptionsKit | out_kit | ) |
Copies this ApplicationWindowOptionsKit into the given ApplicationWindowOptionsKit.
out_kit | The <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref>. |
bool HPS.ApplicationWindowOptionsKit.ShowAntiAliasCapable | ( | out bool | out_state, |
out uint | out_samples | ||
) |
Shows the anti-alias options for this ApplicationWindowOptionsKit.
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.ApplicationWindowOptionsKit.ShowDriver | ( | out HPS.Window.Driver | out_driver | ) |
Shows the driver for this ApplicationWindowOptionsKit.
out_driver | The driver for this <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref>. |
bool HPS.ApplicationWindowOptionsKit.ShowFramebufferRetention | ( | out bool | out_retain | ) |
Shows the framebuffer retention setting for this ApplicationWindowOptionsKit.
out_retain | The framebuffer retention setting for this <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref>. |
bool HPS.ApplicationWindowOptionsKit.ShowPlatformData | ( | out IntPtr | out_platform_data | ) |
Shows the platform specific data for this ApplicationWindowOptionsKit.
out_platform_data | The platform specific data for this <ref refid="class_h_p_s_1_1_application_window_options_kit" kindref="compound">ApplicationWindowOptionsKit</ref>. |
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetAntiAliasCapable | ( | ) |
Removes the anti-alias options for this ApplicationWindowOptionsKit.
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetDriver | ( | ) |
Removes the driver for this ApplicationWindowOptionsKit.
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetEverything | ( | ) |
Removes all settings from this ApplicationWindowOptionsKit.
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetFramebufferRetention | ( | ) |
Removes the framebuffer retention setting for this ApplicationWindowOptionsKit.
HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetPlatformData | ( | ) |
Removes the platform specific data for this ApplicationWindowOptionsKit.