More...

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

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 (if the object is derived, this does not give the true type of the derived object). 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...
 
HPS.ApplicationWindowOptionsKit SetPreferredGPU (HPS.GPU.Preference in_gpu_preference, string in_gpu_name)
 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. <linebreak><linebreak><computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> <ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref> </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> <ref refid="class_h_p_s_1_1_database_1a8f821c6e8493c0da716c76398f3ecdaa" kindref="member">Database.ShowAvailableGPUs()</ref> </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. <linebreak><linebreak> 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(<ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref>, "Microsoft Basic Render Driver")</computeroutput>), DirectX11 will run in software mode. More...
 
HPS.ApplicationWindowOptionsKit SetPreferredGPU (HPS.GPU.Preference in_gpu_preference)
 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. <linebreak><linebreak><computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> <ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref> </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> <ref refid="class_h_p_s_1_1_database_1a8f821c6e8493c0da716c76398f3ecdaa" kindref="member">Database.ShowAvailableGPUs()</ref> </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. <linebreak><linebreak> 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(<ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref>, "Microsoft Basic Render Driver")</computeroutput>), DirectX11 will run in software mode. More...
 
HPS.ApplicationWindowOptionsKit SetScreenAntiAliasing (bool in_state)
 Manipulates the state of screen anti-aliasing. 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...
 
bool ShowPreferredGPU (out HPS.GPU.Preference out_gpu_preference, out string out_gpu_name)
 Shows the preference settings for picking a GPU when multiple GPUs are available. 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...
 
HPS.ApplicationWindowOptionsKit UnsetPreferredGPU ()
 Removes the setting for which GPU should be used when multiple GPUs are available. More...
 
HPS.ApplicationWindowOptionsKit UnsetScreenAntiAliasing ()
 Removes the screen anti-alias options for this ApplicationWindowOptionsKit. More...
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 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). More...
 
override HPS.Type Type ()
 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. More...
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object that)
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 

Static Public Member Functions

static HPS.ApplicationWindowOptionsKit GetDefault ()
 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. More...
 
static bool operator!= (HPS.ApplicationWindowOptionsKit a, HPS.ApplicationWindowOptionsKit b)
 
static bool operator== (HPS.ApplicationWindowOptionsKit a, HPS.ApplicationWindowOptionsKit 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.Kit
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 ApplicationWindowOptionsKit class is a user space object. It is used to specify application-window-specific options. Calling HPS.ApplicationWindowOptionsKit.GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ ApplicationWindowOptionsKit() [1/2]

HPS.ApplicationWindowOptionsKit.ApplicationWindowOptionsKit ( )
inline

The default constructor creates an empty ApplicationWindowOptionsKit object.

◆ ApplicationWindowOptionsKit() [2/2]

HPS.ApplicationWindowOptionsKit.ApplicationWindowOptionsKit ( HPS.ApplicationWindowOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ApplicationWindowOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.ApplicationWindowOptionsKit.Empty ( )
inlinevirtual

Indicates whether this ApplicationWindowOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.

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

◆ GetDefault()

static HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.GetDefault ( )
inlinestatic

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.

Returns
An ApplicationWindowOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.ApplicationWindowOptionsKit.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.Object.

◆ Set()

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

Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.

Parameters
in_kitThe source ApplicationWindowOptionsKit to copy.

◆ SetAntiAliasCapable() [1/2]

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

Sets the anti-alias options for this ApplicationWindowOptionsKit.

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. Defaults to 4.
Returns
A reference to this ApplicationWindowOptionsKit.

◆ SetAntiAliasCapable() [2/2]

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

Sets the anti-alias options for this ApplicationWindowOptionsKit.

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

◆ SetDriver()

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

Sets the driver for this ApplicationWindowOptionsKit.

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

◆ SetFramebufferRetention()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.SetFramebufferRetention ( bool  in_retain)
inline

Sets the framebuffer retention option for this ApplicationWindowOptionsKit.

Parameters
in_retainWhether the associated application window retains the image from the previous frame.
Returns
A reference to this ApplicationWindowOptionsKit.

◆ SetPlatformData()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.SetPlatformData ( IntPtr  in_platform_data)
inline

Sets the platform specific data for this ApplicationWindowOptionsKit.

Parameters
in_platform_dataPlatform specific data for this ApplicationWindowOptionsKit.
Returns
A reference to this ApplicationWindowOptionsKit.

◆ SetPreferredGPU() [1/2]

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.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. <linebreak><linebreak><computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> <ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref> </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> <ref refid="class_h_p_s_1_1_database_1a8f821c6e8493c0da716c76398f3ecdaa" kindref="member">Database.ShowAvailableGPUs()</ref> </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. <linebreak><linebreak> 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(<ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref>, "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 ApplicationWindowOptionsKit.

◆ SetPreferredGPU() [2/2]

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.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. <linebreak><linebreak><computeroutput>in_gpu_name</computeroutput> needs to be specified when <computeroutput>in_gpu_preference</computeroutput> is set to <computeroutput> <ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref> </computeroutput>. The value passed for <computeroutput>in_gpu_name</computeroutput> needs to match one of those returned by <computeroutput> <ref refid="class_h_p_s_1_1_database_1a8f821c6e8493c0da716c76398f3ecdaa" kindref="member">Database.ShowAvailableGPUs()</ref> </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. <linebreak><linebreak> 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(<ref refid="class_h_p_s_1_1_g_p_u_1aa6d73361e48b81929f5ece0f6303d03eafe0619d5f4999e09c622e32da7e7566a" kindref="member">GPU.Preference.Specific</ref>, "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 ApplicationWindowOptionsKit.

◆ SetScreenAntiAliasing()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.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.

◆ Show()

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

Copies this ApplicationWindowOptionsKit into the given ApplicationWindowOptionsKit.

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

◆ ShowAntiAliasCapable()

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

Shows the anti-alias options for this ApplicationWindowOptionsKit.

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.

◆ ShowDriver()

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

Shows the driver for this ApplicationWindowOptionsKit.

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

◆ ShowFramebufferRetention()

bool HPS.ApplicationWindowOptionsKit.ShowFramebufferRetention ( out bool  out_retain)
inline

Shows the framebuffer retention setting for this ApplicationWindowOptionsKit.

Parameters
out_retainThe framebuffer retention setting for this ApplicationWindowOptionsKit.
Returns
true if platform specific data was set, false otherwise.

◆ ShowPlatformData()

bool HPS.ApplicationWindowOptionsKit.ShowPlatformData ( out IntPtr  out_platform_data)
inline

Shows the platform specific data for this ApplicationWindowOptionsKit.

Parameters
out_platform_dataThe platform specific data for this ApplicationWindowOptionsKit.
Returns
true if platform specific data was set, false otherwise.

◆ ShowPreferredGPU()

bool HPS.ApplicationWindowOptionsKit.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.

◆ UnsetAntiAliasCapable()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetAntiAliasCapable ( )
inline

Removes the anti-alias options for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetDriver()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetDriver ( )
inline

Removes the driver for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetEverything()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetFramebufferRetention()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetFramebufferRetention ( )
inline

Removes the framebuffer retention setting for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetPlatformData()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetPlatformData ( )
inline

Removes the platform specific data for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetPreferredGPU()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetPreferredGPU ( )
inline

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

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetScreenAntiAliasing()

HPS.ApplicationWindowOptionsKit HPS.ApplicationWindowOptionsKit.UnsetScreenAntiAliasing ( )
inline

Removes the screen anti-alias options for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

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