OffScreenWindowOptionsKit

class HPS.OffScreenWindowOptionsKit : public HPS.Kit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this OffScreenWindowOptionsKit has any values set on it.

Return: true if no values are set on this OffScreenWindowOptionsKit, false otherwise.

bool Equals (HPS.OffScreenWindowOptionsKit in_kit)

Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit.

Param in_kit: The source OffScreenWindowOptionsKit to compare to this OffScreenWindowOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

override HPS.Type ObjectType ()

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).

Return: The declared type of the object in question, which may differ from the true, underlying type.

OffScreenWindowOptionsKit (): The default constructor creates an empty OffScreenWindowOptionsKit object.

OffScreenWindowOptionsKit (HPS.OffScreenWindowOptionsKit in_kit)

The copy constructor creates a new OffScreenWindowOptionsKit object that contains the same settings as the source OffScreenWindowOptionsKit.

Param in_kit: The source OffScreenWindowOptionsKit to copy.

void Set (HPS.OffScreenWindowOptionsKit in_kit)

Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.

Param in_kit: The source OffScreenWindowOptionsKit to copy.

HPS.OffScreenWindowOptionsKit SetAntiAliasCapable (bool in_state)

Sets the anti-alias options for this OffScreenWindowOptionsKit.

Param in_state: Whether the associated application window should be anti-alias capable.
Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit SetAntiAliasCapable (bool in_state, uint in_samples)

Sets the anti-alias options for this OffScreenWindowOptionsKit.

Param in_state: Whether the associated application window should be anti-alias capable.
Param in_samples: The number of anti-alias samples to use for the associated off-screen window.
Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit SetDriver (HPS.Window.Driver in_driver)

Sets the driver for this OffScreenWindowOptionsKit.

Param in_driver: The driver for this OffScreenWindowOptionsKit.
Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit SetFramebufferRetention (bool in_retain)

Sets the framebuffer retention option for this OffScreenWindowOptionsKit.

Param in_retain: Whether the associated offscreen window retains the image from the previous frame.
Return: A reference to this OffScreenWindowOptionsKit.

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.

Param in_state: Whether the image data for this offscreen window should be stored exclusively in video memory.
Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit SetNativeFormat (HPS.Window.ImageFormat in_format)

Sets the native image format to store data in.

Param in_format: Format image data will be stored in.
Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit SetNativeFormat (HPS.Window.ImageFormat in_format, float in_quality)

Sets the native image format to store data in.

Param in_format: Format image data will be stored in.
Param in_quality: The compression quality for the image data (when applicable).
Return: A reference to this OffScreenWindowOptionsKit.

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.

Param in_state: Whether this offscreen window should support opacity in the window background.
Return: A reference to this OffScreenWindowOptionsKit.

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.

Param in_state: Whether this offscreen window should support opacity in the window background.
Param 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.
Return: A reference to this OffScreenWindowOptionsKit.

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.

Param in_opacity: The opacity value that will be applied when rendering the window background.
Return: A reference to this OffScreenWindowOptionsKit.

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.

<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.

Param in_gpu_preference: Which GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required.
Return: A reference to this OffScreenWindowOptionsKit.

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.

<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.

Param in_gpu_preference: Which GPU to choose. If GPU.Preference.Specific is chosen, the next argument is required.
Param in_gpu_name: The name of the specific GPU to use. Required when in_gpu_preference is GPU.Preference.Specific, ignored otherwise.
Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit SetScreenAntiAliasing (bool in_state)

Manipulates the state of screen anti-aliasing.

Param in_state: Whether screen anti-aliasing should be used.
Return: A reference to this object.

void Show (out HPS.OffScreenWindowOptionsKit out_kit)

Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit.

Param out_kit: The OffScreenWindowOptionsKit to populate with the contents of this OffScreenWindowOptionsKit.

bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)

Shows the anti-alias options for this OffScreenWindowOptionsKit.

Param out_state: Whether the associated application window should be anti-alias capable.
Param out_samples: The number of anti-alias samples to use for the associated application window.
Return: true if anti-alias options were set, false otherwise.

bool ShowDriver (out HPS.Window.Driver out_driver)

Shows the driver for this OffScreenWindowOptionsKit.

Param out_driver: The driver for this OffScreenWindowOptionsKit.
Return: true if a driver was set, false otherwise.

bool ShowFramebufferRetention (out bool out_retain)

Shows the framebuffer retention setting for this OffScreenWindowOptionsKit.

Param out_retain: The framebuffer retention setting for this OffScreenWindowOptionsKit.
Return: true if platform specific data was set, false otherwise.

bool ShowHardwareResident (out bool out_state)

Shows the hardware resident option for this OffScreenWindowOptionsKit.

Param out_state: Whether the image data for this offscreen window should be stored exclusively in video memory.
Return: true if a hardware resident option was set, false otherwise.

bool ShowNativeFormat (out HPS.Window.ImageFormat out_format, out float out_quality)

Shows the native format option for this OffScreenWindowOptionsKit.

Param out_format: Format image data will be stored in.
Param out_quality: The compression quality for the image data (when applicable).
Return: true if a native format option was set, false otherwise.

bool ShowOpacity (out bool out_state, out float out_opacity)

Shows the opacity option for this offscreen window

Param out_state: Whether this offscreen window supports opacity in the window background.
Param out_opacity: The opacity value that will be applied when rendering the window background.
Return: true if an opacity option was set, false otherwise.

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.

Param out_gpu_preference: The preference for picking a GPU when multiple GPUs are available.
Param out_gpu_name: The name of the GPU to use. Only valid when out_gpu_preference is GPU.Preference.Specific
Return: true if a GPU preference was set, false otherwise.

HPS.OffScreenWindowOptionsKit UnsetAntiAliasCapable ()

Removes the anti-alias options for this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetDriver ()

Removes the driver for this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetEverything ()

Removes all settings from this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetFramebufferRetention ()

Removes the framebuffer retention setting for this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetHardwareResident ()

Removes the hardware resident option for this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetNativeFormat ()

Removes the native format option for this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetOpacity ()

Removes the opacity option for this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetPreferredGPU ()

Removes the setting for which GPU should be used when multiple GPUs are available.

Return: A reference to this OffScreenWindowOptionsKit.

HPS.OffScreenWindowOptionsKit UnsetScreenAntiAliasing ()

Removes the screen anti-alias options for this OffScreenWindowOptionsKit.

Return: A reference to this OffScreenWindowOptionsKit.

Public Static Functions

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.

Return: An OffScreenWindowOptionsKit with the default settings.

bool operator!= (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b)

bool operator== (HPS.OffScreenWindowOptionsKit a, HPS.OffScreenWindowOptionsKit b)