
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this OffScreenWindowOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.OffScreenWindowOptionsKit in_kit) |
Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
OffScreenWindowOptionsKit () | |
The default constructor creates an empty OffScreenWindowOptionsKit object. More... | |
OffScreenWindowOptionsKit (HPS.OffScreenWindowOptionsKit in_kit) | |
The copy constructor creates a new OffScreenWindowOptionsKit object that contains the same settings as the source OffScreenWindowOptionsKit. More... | |
void | Set (HPS.OffScreenWindowOptionsKit in_kit) |
Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetAntiAliasCapable (bool in_state, uint in_samples) |
Sets the anti-alias options for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetAntiAliasCapable (bool in_state) |
Sets the anti-alias options for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetDriver (HPS.Window.Driver in_driver) |
Sets the driver for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetFramebufferRetention (bool in_retain) |
Sets the framebuffer retention option for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | SetHardwareResident (bool in_state) |
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. More... | |
HPS.OffScreenWindowOptionsKit | SetNativeFormat (HPS.Window.ImageFormat in_format, float in_quality) |
Sets the native image format to store data in. More... | |
HPS.OffScreenWindowOptionsKit | SetNativeFormat (HPS.Window.ImageFormat in_format) |
Sets the native image format to store data in. More... | |
HPS.OffScreenWindowOptionsKit | SetOpacity (bool in_state, float in_opacity) |
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background. More... | |
HPS.OffScreenWindowOptionsKit | SetOpacity (bool in_state) |
Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background. More... | |
HPS.OffScreenWindowOptionsKit | SetOpacity (float in_opacity) |
Enables support for opacity in the window background and applies the specified opacity value when rendering the window background. More... | |
HPS.OffScreenWindowOptionsKit | 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.OffScreenWindowOptionsKit | 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... | |
void | Show (out HPS.OffScreenWindowOptionsKit out_kit) |
Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit. More... | |
bool | ShowAntiAliasCapable (out bool out_state, out uint out_samples) |
Shows the anti-alias options for this OffScreenWindowOptionsKit. More... | |
bool | ShowDriver (out HPS.Window.Driver out_driver) |
Shows the driver for this OffScreenWindowOptionsKit. More... | |
bool | ShowFramebufferRetention (out bool out_retain) |
Shows the framebuffer retention setting for this OffScreenWindowOptionsKit. More... | |
bool | ShowHardwareResident (out bool out_state) |
Shows the hardware resident option for this OffScreenWindowOptionsKit. More... | |
bool | ShowNativeFormat (out HPS.Window.ImageFormat out_format, out float out_quality) |
Shows the native format option for this OffScreenWindowOptionsKit. More... | |
bool | ShowOpacity (out bool out_state, out float out_opacity) |
Shows the opacity option for this offscreen window 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.OffScreenWindowOptionsKit | UnsetAntiAliasCapable () |
Removes the anti-alias options for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetDriver () |
Removes the driver for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetEverything () |
Removes all settings from this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetFramebufferRetention () |
Removes the framebuffer retention setting for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetHardwareResident () |
Removes the hardware resident option for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetNativeFormat () |
Removes the native format option for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetOpacity () |
Removes the opacity option for this OffScreenWindowOptionsKit. More... | |
HPS.OffScreenWindowOptionsKit | UnsetPreferredGPU () |
Removes the setting for which GPU should be used when multiple GPUs are available. 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 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.OffScreenWindowOptionsKit | 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. More... | |
static bool | operator!= (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b) |
static bool | operator== (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
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.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty OffScreenWindowOptionsKit object.
|
inline |
The copy constructor creates a new OffScreenWindowOptionsKit object that contains the same settings as the source OffScreenWindowOptionsKit.
- Parameters
-
in_kit The source OffScreenWindowOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this OffScreenWindowOptionsKit has any values set on it.
- Returns
- true if no values are set on this OffScreenWindowOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit.
- Parameters
-
in_kit The source OffScreenWindowOptionsKit to compare to this OffScreenWindowOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
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.
|
inline |
Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.
- Parameters
-
in_kit The source OffScreenWindowOptionsKit to copy.
|
inline |
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.
|
inline |
Sets the anti-alias options for this OffScreenWindowOptionsKit.
- Parameters
-
in_state Whether the associated application window should be anti-alias capable.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Sets the driver for this OffScreenWindowOptionsKit.
- Parameters
-
in_driver The driver for this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Sets the framebuffer retention option for this OffScreenWindowOptionsKit.
- Parameters
-
in_retain Whether the associated offscreen window retains the image from the previous frame.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
inline |
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.
|
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 OffScreenWindowOptionsKit.
|
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 OffScreenWindowOptionsKit.
|
inline |
Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit.
- Parameters
-
out_kit The OffScreenWindowOptionsKit to populate with the contents of this OffScreenWindowOptionsKit.
|
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.
|
inline |
Shows the driver for this OffScreenWindowOptionsKit.
- Parameters
-
out_driver The driver for this OffScreenWindowOptionsKit.
- Returns
- true if a driver was set, false otherwise.
|
inline |
Shows the framebuffer retention setting for this OffScreenWindowOptionsKit.
- Parameters
-
out_retain The framebuffer retention setting for this OffScreenWindowOptionsKit.
- Returns
- true if platform specific data was set, false otherwise.
|
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.
|
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.
|
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.
|
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 |
Removes the anti-alias options for this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Removes the driver for this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Removes all settings from this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Removes the framebuffer retention setting for this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Removes the hardware resident option for this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Removes the native format option for this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Removes the opacity option for this OffScreenWindowOptionsKit.
- Returns
- A reference to this OffScreenWindowOptionsKit.
|
inline |
Removes the setting for which GPU should be used when multiple GPUs are available.
- Returns
- A reference to this OffScreenWindowOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.OffScreenWindowOptionsKit.cs