Inheritance diagram for HPS.StandAloneWindowOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.StandAloneWindowOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.StandAloneWindowOptionsKit in_kit)
 
HPS.StandAloneWindowOptionsKit SetAntiAliasCapable (bool in_state, uint in_samples)
 
HPS.StandAloneWindowOptionsKit SetAntiAliasCapable (bool in_state)
 
HPS.StandAloneWindowOptionsKit SetDriver (HPS.Window.Driver in_driver)
 
HPS.StandAloneWindowOptionsKit SetFullScreen (bool in_state)
 
HPS.StandAloneWindowOptionsKit SetMobility (HPS.Window.Mobility in_mobility)
 
HPS.StandAloneWindowOptionsKit SetPreferredGPU (HPS.GPU.Preference in_gpu_preference, string in_gpu_name)
 
HPS.StandAloneWindowOptionsKit SetPreferredGPU (HPS.GPU.Preference in_gpu_preference)
 
HPS.StandAloneWindowOptionsKit SetScreenAntiAliasing (bool in_state)
 
HPS.StandAloneWindowOptionsKit SetSubscreen (HPS.Rectangle in_subscreen)
 
HPS.StandAloneWindowOptionsKit SetTitle (string in_window_name)
 
void Show (out HPS.StandAloneWindowOptionsKit out_kit)
 
bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)
 
bool ShowDriver (out HPS.Window.Driver out_driver)
 
bool ShowFullScreen (out bool out_state)
 
bool ShowMobility (out HPS.Window.Mobility out_mobility)
 
bool ShowPreferredGPU (out HPS.GPU.Preference out_gpu_preference, out string out_gpu_name)
 
bool ShowSubscreen (out HPS.Rectangle out_subscreen)
 
bool ShowTitle (out string out_window_name)
 
 StandAloneWindowOptionsKit ()
 
 StandAloneWindowOptionsKit (HPS.StandAloneWindowOptionsKit in_kit)
 
HPS.StandAloneWindowOptionsKit UnsetAntiAliasCapable ()
 
HPS.StandAloneWindowOptionsKit UnsetDriver ()
 
HPS.StandAloneWindowOptionsKit UnsetEverything ()
 
HPS.StandAloneWindowOptionsKit UnsetFullScreen ()
 
HPS.StandAloneWindowOptionsKit UnsetMobility ()
 
HPS.StandAloneWindowOptionsKit UnsetPreferredGPU ()
 
HPS.StandAloneWindowOptionsKit UnsetScreenAntiAliasing ()
 
HPS.StandAloneWindowOptionsKit UnsetSubscreen ()
 
HPS.StandAloneWindowOptionsKit UnsetTitle ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.StandAloneWindowOptionsKit GetDefault ()
 
static bool operator!= (HPS.StandAloneWindowOptionsKit a, HPS.StandAloneWindowOptionsKit b)
 
static bool operator== (HPS.StandAloneWindowOptionsKit a, HPS.StandAloneWindowOptionsKit 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
 

Detailed Description

The StandAloneWindowOptionsKit class is a user space object. It is used to specify stand-alone-window-specific options Calling HPS.StandAloneWindowOptionsKit.GetDefault() will return an options kit with values found in this table.

Standalone windows are not supported on Android, iOS, or macOS as all GUI / windowing is controlled at the application level.

Constructor & Destructor Documentation

◆ StandAloneWindowOptionsKit() [1/2]

HPS.StandAloneWindowOptionsKit.StandAloneWindowOptionsKit ( )
inline

The default constructor creates an empty StandAloneWindowOptionsKit object.

◆ StandAloneWindowOptionsKit() [2/2]

HPS.StandAloneWindowOptionsKit.StandAloneWindowOptionsKit ( HPS.StandAloneWindowOptionsKit  in_kit)
inline

The copy constructor creates a new StandAloneWindowOptionsKit object that contains the same settings as the source StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.StandAloneWindowOptionsKit.Empty ( )
inlinevirtual

Indicates whether this StandAloneWindowOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.StandAloneWindowOptionsKit.Equals ( HPS.StandAloneWindowOptionsKit  in_kit)
inline

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.GetDefault ( )
inlinestatic

Creates an StandAloneWindowOptionsKit 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 StandAloneWindowOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.StandAloneWindowOptionsKit.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.Kit.

◆ Set()

void HPS.StandAloneWindowOptionsKit.Set ( HPS.StandAloneWindowOptionsKit  in_kit)
inline

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to copy.

◆ SetAntiAliasCapable() [1/2]

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetAntiAliasCapable ( bool  in_state,
uint  in_samples 
)
inline

Sets the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
in_samplesThe number of anti-alias samples to use for the associated stand-alone window. Defaults to 4.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetAntiAliasCapable() [2/2]

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetAntiAliasCapable ( bool  in_state)
inline

Sets the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetDriver()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetDriver ( HPS.Window.Driver  in_driver)
inline

Sets the driver for this StandAloneWindowOptionsKit.

Parameters
in_driverThe driver for this StandAloneWindowOptionsKit.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetFullScreen()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetFullScreen ( bool  in_state)
inline

Sets whether the associated stand-alone window should fill the screen.

Parameters
in_stateWhether the associated stand-alone window should fill the screen.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetMobility()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetMobility ( HPS.Window.Mobility  in_mobility)
inline

Sets the mobility for this StandAloneWindowOptionsKit.

Parameters
in_mobilityThe mobility for this StandAloneWindowOptionsKit.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetPreferredGPU() [1/2]

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetPreferredGPU ( HPS.GPU.Preference  in_gpu_preference,
string  in_gpu_name 
)
inline

Sets which GPU to use when there are multiple available GPUs on a system. This method is only available when using the DirectX11 driver. Other drivers will ignore this request.

<computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> GPU.Preference.Specific </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> Database.ShowAvailableGPUs() </computeroutput>. If you select something other than default GPU, and Visualize cannot find a GPU which satisfies the requirement, the default GPU will be used.

All Visualize windows using DirectX11 will use the same GPU. The user should select the preferred GPU before creating a DirectX11 window. The default is for DirectX11 windows to use HighPerformance GPUs. The Microsoft Basic Software Render Driver is always returned as one of the available GPUs by DirectX11. By selecting it (which users can do by calling <computeroutput>SetPreferredGPU(GPU.Preference.Specific, "Microsoft Basic Render Driver")</computeroutput>), DirectX11 will run in software mode.

Parameters
in_gpu_preferenceWhich GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required.
in_gpu_nameThe name of the specific GPU to use. Required when in_gpu_preference is GPU.Preference.Specific, ignored otherwise.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetPreferredGPU() [2/2]

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetPreferredGPU ( HPS.GPU.Preference  in_gpu_preference)
inline

Sets which GPU to use when there are multiple available GPUs on a system. This method is only available when using the DirectX11 driver. Other drivers will ignore this request.

<computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> GPU.Preference.Specific </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> Database.ShowAvailableGPUs() </computeroutput>. If you select something other than default GPU, and Visualize cannot find a GPU which satisfies the requirement, the default GPU will be used.

All Visualize windows using DirectX11 will use the same GPU. The user should select the preferred GPU before creating a DirectX11 window. The default is for DirectX11 windows to use HighPerformance GPUs. The Microsoft Basic Software Render Driver is always returned as one of the available GPUs by DirectX11. By selecting it (which users can do by calling <computeroutput>SetPreferredGPU(GPU.Preference.Specific, "Microsoft Basic Render Driver")</computeroutput>), DirectX11 will run in software mode.

Parameters
in_gpu_preferenceWhich GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetScreenAntiAliasing()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetScreenAntiAliasing ( bool  in_state)
inline

Manipulates the state of screen anti-aliasing.

Parameters
in_stateWhether screen anti-aliasing should be used.
Returns
A reference to this object.

◆ SetSubscreen()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetSubscreen ( HPS.Rectangle  in_subscreen)
inline

Sets the subscreen to render into for this StandAloneWindowOptionsKit.

Parameters
in_subscreenThe subscreen to render into for this StandAloneWindowOptionsKit. 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 StandAloneWindowOptionsKit.

◆ SetTitle()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.SetTitle ( string  in_window_name)
inline

Sets the title for this StandAloneWindowOptionsKit.

Parameters
in_window_nameUTF8-encoded title for this StandAloneWindowOptionsKit.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ Show()

void HPS.StandAloneWindowOptionsKit.Show ( out HPS.StandAloneWindowOptionsKit  out_kit)
inline

Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.

Parameters
out_kitThe StandAloneWindowOptionsKit to populate with the contents of this StandAloneWindowOptionsKit.

◆ ShowAntiAliasCapable()

bool HPS.StandAloneWindowOptionsKit.ShowAntiAliasCapable ( out bool  out_state,
out uint  out_samples 
)
inline

Shows the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
out_stateWhether the associated stand-alone window should be anti-alias capable.
out_samplesThe number of anti-alias samples to use for the stand-alone application window.
Returns
true if anti-alias options were set, false otherwise.

◆ ShowDriver()

bool HPS.StandAloneWindowOptionsKit.ShowDriver ( out HPS.Window.Driver  out_driver)
inline

Shows the driver for this StandAloneWindowOptionsKit.

Parameters
out_driverThe driver for this StandAloneWindowOptionsKit.
Returns
true if a driver was set, false otherwise.

◆ ShowFullScreen()

bool HPS.StandAloneWindowOptionsKit.ShowFullScreen ( out bool  out_state)
inline

Shows whether the associated stand-alone window should fill the screen.

Parameters
out_stateWhether the associated stand-alone window should fill the screen.
Returns
true if a full screen flag was set, false otherwise.

◆ ShowMobility()

bool HPS.StandAloneWindowOptionsKit.ShowMobility ( out HPS.Window.Mobility  out_mobility)
inline

Shows the mobility for this StandAloneWindowOptionsKit.

Parameters
out_mobilityThe mobility for this StandAloneWindowOptionsKit.
Returns
true if a mobility was set, false otherwise.

◆ ShowPreferredGPU()

bool HPS.StandAloneWindowOptionsKit.ShowPreferredGPU ( out HPS.GPU.Preference  out_gpu_preference,
out string  out_gpu_name 
)
inline

Shows the preference settings for picking a GPU when multiple GPUs are available.

Parameters
out_gpu_preferenceThe preference for picking a GPU when multiple GPUs are available.
out_gpu_nameThe name of the GPU to use. Only valid when out_gpu_preference is GPU.Preference.Specific
Returns
true if a GPU preference was set, false otherwise.

◆ ShowSubscreen()

bool HPS.StandAloneWindowOptionsKit.ShowSubscreen ( out HPS.Rectangle  out_subscreen)
inline

Shows the subscreen for this StandAloneWindowOptionsKit.

Parameters
out_subscreenThe subscreen for this StandAloneWindowOptionsKit.
Returns
true if a subscreen was set, false otherwise.

◆ ShowTitle()

bool HPS.StandAloneWindowOptionsKit.ShowTitle ( out string  out_window_name)
inline

Shows the title for this StandAloneWindowOptionsKit.

Parameters
out_window_nameUTF8-encoded title for this StandAloneWindowOptionsKit.
Returns
true if a title was set, false otherwise.

◆ UnsetAntiAliasCapable()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetAntiAliasCapable ( )
inline

Removes the anti-alias options for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetDriver()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetDriver ( )
inline

Removes the driver for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetEverything()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetEverything ( )
inline

Removes all settings from this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetFullScreen()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetFullScreen ( )
inline

Removes whether the associated stand-alone window should fill the screen.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetMobility()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetMobility ( )
inline

Removes the mobility for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetPreferredGPU()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetPreferredGPU ( )
inline

Removes the setting for which GPU should be used when multiple GPUs are available.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetScreenAntiAliasing()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetScreenAntiAliasing ( )
inline

Removes the screen anti-alias options for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetSubscreen()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetSubscreen ( )
inline

Removes the subscreen for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetTitle()

HPS.StandAloneWindowOptionsKit HPS.StandAloneWindowOptionsKit.UnsetTitle ( )
inline

Removes the title for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.StandAloneWindowOptionsKit.cs