< Home

< Table of Contents

REFERENCE MANUAL

HPS.OffScreenWindowOptionsKit Class Reference

The OffScreenWindowOptionsKit class is a user space object. More...

Inheritance diagram for HPS.OffScreenWindowOptionsKit:
HPS.Object

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...
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

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.

Constructor & Destructor Documentation

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.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref> to copy.

Member Function Documentation

override bool HPS.OffScreenWindowOptionsKit.Empty ( )
virtual

Indicates whether this OffScreenWindowOptionsKit has any values set on it.

Returns
true if no values are set on this OffScreenWindowOptionsKit, false otherwise.

Reimplemented from HPS.Object.

bool HPS.OffScreenWindowOptionsKit.Equals ( HPS.OffScreenWindowOptionsKit  in_kit)

Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.GetDefault ( )
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.

Returns
An OffScreenWindowOptionsKit with the default settings.
override HPS.Type HPS.OffScreenWindowOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

void HPS.OffScreenWindowOptionsKit.Set ( HPS.OffScreenWindowOptionsKit  in_kit)

Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.

Parameters
in_kitThe 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.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
in_samplesThe number of anti-alias samples to use for the associated application window.
Returns
A reference to this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetAntiAliasCapable ( bool  in_state)

Sets the anti-alias options for this OffScreenWindowOptionsKit.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
Returns
A reference to this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.SetDriver ( HPS.Window.Driver  in_driver)

Sets the driver for this OffScreenWindowOptionsKit.

Parameters
in_driverThe driver for this <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref>.
Returns
A reference to this OffScreenWindowOptionsKit.
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.

Parameters
in_stateWhether the image data for this offscreen window should be stored exclusively in video memory.
Returns
A reference to this OffScreenWindowOptionsKit.
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.

Parameters
in_stateWhether this offscreen window should support opacity in the window background.
in_opacityThe 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.
Returns
A reference to this OffScreenWindowOptionsKit.
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.

Parameters
in_stateWhether this offscreen window should support opacity in the window background.
Returns
A reference to this OffScreenWindowOptionsKit.
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.

Parameters
in_opacityThe opacity value that will be applied when rendering the window background.
Returns
A reference to this OffScreenWindowOptionsKit.
void HPS.OffScreenWindowOptionsKit.Show ( out HPS.OffScreenWindowOptionsKit  out_kit)

Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit.

Parameters
out_kitThe <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.

Parameters
out_stateWhether the associated application window should be anti-alias capable.
out_samplesThe number of anti-alias samples to use for the associated application window.
Returns
true if anti-alias options were set, false otherwise.
bool HPS.OffScreenWindowOptionsKit.ShowDriver ( out HPS.Window.Driver  out_driver)

Shows the driver for this OffScreenWindowOptionsKit.

Parameters
out_driverThe driver for this <ref refid="class_h_p_s_1_1_off_screen_window_options_kit" kindref="compound">OffScreenWindowOptionsKit</ref>.
Returns
true if a driver was set, false otherwise.
bool HPS.OffScreenWindowOptionsKit.ShowHardwareResident ( out bool  out_state)

Shows the hardware resident option for this OffScreenWindowOptionsKit.

Parameters
out_stateWhether the image data for this offscreen window should be stored exclusively in video memory.
Returns
true if a hardware resident option was set, false otherwise.
bool HPS.OffScreenWindowOptionsKit.ShowOpacity ( out bool  out_state,
out float  out_opacity 
)

Shows the opacity option for this offscreen window

Parameters
out_stateThe opacity value that will be applied when rendering the window background.
Returns
true if an opacity option was set, false otherwise.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetAntiAliasCapable ( )

Removes the anti-alias options for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetDriver ( )

Removes the driver for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetEverything ( )

Removes all settings from this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetHardwareResident ( )

Removes the hardware resident option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.
HPS.OffScreenWindowOptionsKit HPS.OffScreenWindowOptionsKit.UnsetOpacity ( )

Removes the opacity option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

The documentation for this class was generated from the following file: