|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ StandAloneWindowOptionsKit() [1/2]
HPS.StandAloneWindowOptionsKit.StandAloneWindowOptionsKit |
( |
| ) |
|
|
inline |
◆ StandAloneWindowOptionsKit() [2/2]
◆ Empty()
override bool HPS.StandAloneWindowOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ 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.
- 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()
◆ SetAntiAliasCapable() [1/2]
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.
◆ SetAntiAliasCapable() [2/2]
◆ SetDriver()
◆ SetFullScreen()
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.
◆ SetMobility()
◆ 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.
<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
-
- Returns
- A reference to this StandAloneWindowOptionsKit.
◆ 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.
<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
-
- Returns
- A reference to this StandAloneWindowOptionsKit.
◆ SetScreenAntiAliasing()
Manipulates the state of screen anti-aliasing.
- Parameters
-
in_state | Whether screen anti-aliasing should be used. |
- Returns
- A reference to this object.
◆ SetSubscreen()
◆ SetTitle()
◆ Show()
◆ ShowAntiAliasCapable()
bool HPS.StandAloneWindowOptionsKit.ShowAntiAliasCapable |
( |
out bool |
out_state, |
|
|
out uint |
out_samples |
|
) |
| |
|
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.
◆ ShowDriver()
◆ ShowFullScreen()
bool HPS.StandAloneWindowOptionsKit.ShowFullScreen |
( |
out bool |
out_state | ) |
|
|
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.
◆ ShowMobility()
◆ 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_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.
◆ ShowSubscreen()
bool HPS.StandAloneWindowOptionsKit.ShowSubscreen |
( |
out HPS.Rectangle |
out_subscreen | ) |
|
|
inline |
◆ ShowTitle()
bool HPS.StandAloneWindowOptionsKit.ShowTitle |
( |
out string |
out_window_name | ) |
|
|
inline |
◆ UnsetAntiAliasCapable()
◆ UnsetDriver()
◆ UnsetEverything()
◆ UnsetFullScreen()
◆ UnsetMobility()
◆ UnsetPreferredGPU()
◆ UnsetScreenAntiAliasing()
◆ UnsetSubscreen()
◆ UnsetTitle()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.StandAloneWindowOptionsKit.cs