|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
The HPS.OffScreenWindowOptionsKit class is a user space object. It is used to specify off-screen-window-specific options. Calling HPS.OffScreenWindowOptionsKit.GetDefault() will return an options kit with values found in this table.
◆ OffScreenWindowOptionsKit() [1/2]
HPS.OffScreenWindowOptionsKit.OffScreenWindowOptionsKit |
( |
| ) |
|
|
inline |
◆ OffScreenWindowOptionsKit() [2/2]
◆ Empty()
override bool HPS.OffScreenWindowOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ GetDefault()
Creates an OffScreenWindowOptionsKit 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 OffScreenWindowOptionsKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.OffScreenWindowOptionsKit.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 OffScreenWindowOptionsKit.
- 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 off-screen window. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
◆ SetAntiAliasCapable() [2/2]
◆ SetDriver()
◆ SetFramebufferRetention()
◆ SetHardwareResident()
Sets whether the image data for this offscreen window should be stored exclusively in video memory. Storing the image in video memory improves the update time but may make the image data inaccessible directly.
- Parameters
-
in_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
◆ SetNativeFormat() [1/2]
Sets the native image format to store data in.
- Parameters
-
in_format | Format image data will be stored in. |
in_quality | The compression quality for the image data (when applicable). |
- Returns
- A reference to this OffScreenWindowOptionsKit.
◆ SetNativeFormat() [2/2]
Sets the native image format to store data in.
- Parameters
-
in_format | Format image data will be stored in. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
◆ SetOpacity() [1/3]
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.
- Parameters
-
in_state | Whether this offscreen window should support opacity in the window background. |
in_opacity | The opacity value that will be applied when rendering the window background. The value is clamped if the opacity is outside the range 0 to 1. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
◆ SetOpacity() [2/3]
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.
- Parameters
-
in_state | Whether this offscreen window should support opacity in the window background. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
◆ SetOpacity() [3/3]
Enables support for opacity in the window background and applies the specified opacity value when rendering the window background.
- Parameters
-
in_opacity | The opacity value that will be applied when rendering the window background. |
- Returns
- A reference to this OffScreenWindowOptionsKit.
◆ 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 OffScreenWindowOptionsKit.
◆ 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 OffScreenWindowOptionsKit.
◆ 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.OffScreenWindowOptionsKit.ShowAntiAliasCapable |
( |
out bool |
out_state, |
|
|
out uint |
out_samples |
|
) |
| |
|
inline |
Shows the anti-alias options for this OffScreenWindowOptionsKit.
- 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.OffScreenWindowOptionsKit.ShowFramebufferRetention |
( |
out bool |
out_retain | ) |
|
|
inline |
Shows the framebuffer retention setting for this OffScreenWindowOptionsKit.
- Parameters
-
- Returns
- true if platform specific data was set, false otherwise.
◆ ShowHardwareResident()
bool HPS.OffScreenWindowOptionsKit.ShowHardwareResident |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the hardware resident option for this OffScreenWindowOptionsKit.
- Parameters
-
out_state | Whether the image data for this offscreen window should be stored exclusively in video memory. |
- Returns
- true if a hardware resident option was set, false otherwise.
◆ ShowNativeFormat()
bool HPS.OffScreenWindowOptionsKit.ShowNativeFormat |
( |
out HPS.Window.ImageFormat |
out_format, |
|
|
out float |
out_quality |
|
) |
| |
|
inline |
Shows the native format option for this OffScreenWindowOptionsKit.
- Parameters
-
out_format | Format image data will be stored in. |
out_quality | The compression quality for the image data (when applicable). |
- Returns
- true if a native format option was set, false otherwise.
◆ ShowOpacity()
bool HPS.OffScreenWindowOptionsKit.ShowOpacity |
( |
out bool |
out_state, |
|
|
out float |
out_opacity |
|
) |
| |
|
inline |
Shows the opacity option for this offscreen window
- Parameters
-
out_state | Whether this offscreen window supports opacity in the window background. |
out_opacity | The opacity value that will be applied when rendering the window background. |
- Returns
- true if an opacity option was set, false otherwise.
◆ ShowPreferredGPU()
bool HPS.OffScreenWindowOptionsKit.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()
◆ UnsetHardwareResident()
◆ UnsetNativeFormat()
◆ UnsetOpacity()
◆ UnsetPreferredGPU()
◆ UnsetScreenAntiAliasing()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.OffScreenWindowOptionsKit.cs