|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ ApplicationWindowOptionsKit() [1/2]
HPS.ApplicationWindowOptionsKit.ApplicationWindowOptionsKit |
( |
| ) |
|
|
inline |
◆ ApplicationWindowOptionsKit() [2/2]
◆ Empty()
override bool HPS.ApplicationWindowOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ 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.
- 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()
◆ SetAntiAliasCapable() [1/2]
Sets the anti-alias options for this ApplicationWindowOptionsKit.
- 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 application window. Defaults to 4. |
- Returns
- A reference to this ApplicationWindowOptionsKit.
◆ SetAntiAliasCapable() [2/2]
◆ SetDriver()
◆ SetFramebufferRetention()
◆ SetPlatformData()
◆ SetPreferredGPU() [1/2]
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
-
- Returns
- A reference to this ApplicationWindowOptionsKit.
◆ SetPreferredGPU() [2/2]
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
-
- Returns
- A reference to this ApplicationWindowOptionsKit.
◆ SetScreenAntiAliasing()
Manipulates the state of screen anti-aliasing.
- Parameters
-
in_state | Whether screen anti-aliasing should be used. |
- Returns
- A reference to this object.
◆ Show()
◆ ShowAntiAliasCapable()
bool HPS.ApplicationWindowOptionsKit.ShowAntiAliasCapable |
( |
out bool |
out_state, |
|
|
out uint |
out_samples |
|
) |
| |
|
inline |
Shows the anti-alias options for this ApplicationWindowOptionsKit.
- Parameters
-
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. |
- Returns
- true if anti-alias options were set, false otherwise.
◆ ShowDriver()
◆ ShowFramebufferRetention()
bool HPS.ApplicationWindowOptionsKit.ShowFramebufferRetention |
( |
out bool |
out_retain | ) |
|
|
inline |
Shows the framebuffer retention setting for this ApplicationWindowOptionsKit.
- Parameters
-
- 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
-
- 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_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.
◆ UnsetAntiAliasCapable()
◆ UnsetDriver()
◆ UnsetEverything()
◆ UnsetFramebufferRetention()
◆ UnsetPlatformData()
◆ UnsetPreferredGPU()
◆ UnsetScreenAntiAliasing()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ApplicationWindowOptionsKit.cs