
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this StandAloneWindowOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.StandAloneWindowOptionsKit in_kit) |
Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
void | Set (HPS.StandAloneWindowOptionsKit in_kit) |
Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | SetAntiAliasCapable (bool in_state, uint in_samples) |
Sets the anti-alias options for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | SetAntiAliasCapable (bool in_state) |
Sets the anti-alias options for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | SetDriver (HPS.Window.Driver in_driver) |
Sets the driver for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | SetFullScreen (bool in_state) |
Sets whether the associated stand-alone window should fill the screen. More... | |
HPS.StandAloneWindowOptionsKit | SetMobility (HPS.Window.Mobility in_mobility) |
Sets the mobility for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | 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.StandAloneWindowOptionsKit | 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.StandAloneWindowOptionsKit | SetSubscreen (HPS.Rectangle in_subscreen) |
Sets the subscreen to render into for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | SetTitle (string in_window_name) |
Sets the title for this StandAloneWindowOptionsKit. More... | |
void | Show (out HPS.StandAloneWindowOptionsKit out_kit) |
Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit. More... | |
bool | ShowAntiAliasCapable (out bool out_state, out uint out_samples) |
Shows the anti-alias options for this StandAloneWindowOptionsKit. More... | |
bool | ShowDriver (out HPS.Window.Driver out_driver) |
Shows the driver for this StandAloneWindowOptionsKit. More... | |
bool | ShowFullScreen (out bool out_state) |
Shows whether the associated stand-alone window should fill the screen. More... | |
bool | ShowMobility (out HPS.Window.Mobility out_mobility) |
Shows the mobility for this StandAloneWindowOptionsKit. 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... | |
bool | ShowSubscreen (out HPS.Rectangle out_subscreen) |
Shows the subscreen for this StandAloneWindowOptionsKit. More... | |
bool | ShowTitle (out string out_window_name) |
Shows the title for this StandAloneWindowOptionsKit. More... | |
StandAloneWindowOptionsKit () | |
The default constructor creates an empty StandAloneWindowOptionsKit object. More... | |
StandAloneWindowOptionsKit (HPS.StandAloneWindowOptionsKit in_kit) | |
The copy constructor creates a new StandAloneWindowOptionsKit object that contains the same settings as the source StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | UnsetAntiAliasCapable () |
Removes the anti-alias options for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | UnsetDriver () |
Removes the driver for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | UnsetEverything () |
Removes all settings from this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | UnsetFullScreen () |
Removes whether the associated stand-alone window should fill the screen. More... | |
HPS.StandAloneWindowOptionsKit | UnsetMobility () |
Removes the mobility for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | UnsetPreferredGPU () |
Removes the setting for which GPU should be used when multiple GPUs are available. More... | |
HPS.StandAloneWindowOptionsKit | UnsetSubscreen () |
Removes the subscreen for this StandAloneWindowOptionsKit. More... | |
HPS.StandAloneWindowOptionsKit | UnsetTitle () |
Removes the title for this StandAloneWindowOptionsKit. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. 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.StandAloneWindowOptionsKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.StandAloneWindowOptionsKit a, HPS.StandAloneWindowOptionsKit b) |
static bool | operator== (HPS.StandAloneWindowOptionsKit a, HPS.StandAloneWindowOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty StandAloneWindowOptionsKit object.
|
inline |
The copy constructor creates a new StandAloneWindowOptionsKit object that contains the same settings as the source StandAloneWindowOptionsKit.
- Parameters
-
in_kit The source StandAloneWindowOptionsKit to copy.
Member Function Documentation
|
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.
|
inline |
Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.
- Parameters
-
in_kit The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
|
inline |
Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.
- Parameters
-
in_kit The source StandAloneWindowOptionsKit to copy.
|
inline |
Sets the anti-alias options for this StandAloneWindowOptionsKit.
- Parameters
-
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 stand-alone window. Defaults to 4.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Sets the anti-alias options for this StandAloneWindowOptionsKit.
- Parameters
-
in_state Whether the associated application window should be anti-alias capable.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Sets the driver for this StandAloneWindowOptionsKit.
- Parameters
-
in_driver The driver for this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Sets whether the associated stand-alone window should fill the screen.
- Parameters
-
in_state Whether the associated stand-alone window should fill the screen.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Sets the mobility for this StandAloneWindowOptionsKit.
- Parameters
-
in_mobility The mobility for this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
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_preference Which GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required. in_gpu_name The name of the specific GPU to use. Required when in_gpu_preference is GPU.Preference.Specific, ignored otherwise.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
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_preference Which GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Sets the subscreen to render into for this StandAloneWindowOptionsKit.
- Parameters
-
in_subscreen The 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.
|
inline |
Sets the title for this StandAloneWindowOptionsKit.
- Parameters
-
in_window_name UTF8-encoded title for this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.
- Parameters
-
out_kit The StandAloneWindowOptionsKit to populate with the contents of this StandAloneWindowOptionsKit.
|
inline |
Shows the anti-alias options for this StandAloneWindowOptionsKit.
- Parameters
-
out_state Whether the associated stand-alone window should be anti-alias capable. out_samples The number of anti-alias samples to use for the stand-alone application window.
- Returns
- true if anti-alias options were set, false otherwise.
|
inline |
Shows the driver for this StandAloneWindowOptionsKit.
- Parameters
-
out_driver The driver for this StandAloneWindowOptionsKit.
- Returns
- true if a driver was set, false otherwise.
|
inline |
Shows whether the associated stand-alone window should fill the screen.
- Parameters
-
out_state Whether the associated stand-alone window should fill the screen.
- Returns
- true if a full screen flag was set, false otherwise.
|
inline |
Shows the mobility for this StandAloneWindowOptionsKit.
- Parameters
-
out_mobility The mobility for this StandAloneWindowOptionsKit.
- Returns
- true if a mobility was set, false otherwise.
|
inline |
Shows the preference settings for picking a GPU when multiple GPUs are available.
- Parameters
-
out_gpu_preference The preference for picking a GPU when multiple GPUs are available. out_gpu_name The 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.
|
inline |
Shows the subscreen for this StandAloneWindowOptionsKit.
- Parameters
-
out_subscreen The subscreen for this StandAloneWindowOptionsKit.
- Returns
- true if a subscreen was set, false otherwise.
|
inline |
Shows the title for this StandAloneWindowOptionsKit.
- Parameters
-
out_window_name UTF8-encoded title for this StandAloneWindowOptionsKit.
- Returns
- true if a title was set, false otherwise.
|
inline |
Removes the anti-alias options for this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Removes the driver for this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Removes all settings from this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Removes whether the associated stand-alone window should fill the screen.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Removes the mobility for this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Removes the setting for which GPU should be used when multiple GPUs are available.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
inline |
Removes the subscreen for this StandAloneWindowOptionsKit.
- Returns
- A reference to this StandAloneWindowOptionsKit.
|
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