ApplicationWindowOptionsKit

class HPS.ApplicationWindowOptionsKit : public HPS.Kit

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.

Public Functions

ApplicationWindowOptionsKit ()

The default constructor creates an empty ApplicationWindowOptionsKit object.

ApplicationWindowOptionsKit (HPS.ApplicationWindowOptionsKit in_kit)

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

Param in_kit

The source ApplicationWindowOptionsKit to copy.

override void Dispose ()

override bool Empty ()

Indicates whether this ApplicationWindowOptionsKit has any values set on it.

Return

true if no values are set on this ApplicationWindowOptionsKit, false otherwise.

bool Equals (HPS.ApplicationWindowOptionsKit in_kit)

Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.

Param in_kit

The source ApplicationWindowOptionsKit to compare to this ApplicationWindowOptionsKit.

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.

void Set (HPS.ApplicationWindowOptionsKit in_kit)

Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.

Param in_kit

The source ApplicationWindowOptionsKit to copy.

HPS.ApplicationWindowOptionsKit SetAntiAliasCapable (bool in_state)

Sets the anti-alias options for this ApplicationWindowOptionsKit.

Param in_state

Whether the associated application window should be anti-alias capable.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit SetAntiAliasCapable (bool in_state, uint in_samples)

Sets the anti-alias options for this ApplicationWindowOptionsKit.

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 application window. Defaults to 4.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit SetDriver (HPS.Window.Driver in_driver)

Sets the driver for this ApplicationWindowOptionsKit.

Param in_driver

The driver for this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit SetFramebufferRetention (bool in_retain)

Sets the framebuffer retention option for this ApplicationWindowOptionsKit.

Param in_retain

Whether the associated application window retains the image from the previous frame.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit SetPlatformData (IntPtr in_platform_data)

Sets the platform specific data for this ApplicationWindowOptionsKit.

Param in_platform_data

Platform specific data for this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

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

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

HPS.ApplicationWindowOptionsKit 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.ApplicationWindowOptionsKit out_kit)

Copies this ApplicationWindowOptionsKit into the given ApplicationWindowOptionsKit.

Param out_kit

The ApplicationWindowOptionsKit to populate with the contents of this ApplicationWindowOptionsKit.

bool ShowAntiAliasCapable (out bool out_state, out uint out_samples)

Shows the anti-alias options for this ApplicationWindowOptionsKit.

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

Param out_driver

The driver for this ApplicationWindowOptionsKit.

Return

true if a driver was set, false otherwise.

bool ShowFramebufferRetention (out bool out_retain)

Shows the framebuffer retention setting for this ApplicationWindowOptionsKit.

Param out_retain

The framebuffer retention setting for this ApplicationWindowOptionsKit.

Return

true if platform specific data was set, false otherwise.

bool ShowPlatformData (out IntPtr out_platform_data)

Shows the platform specific data for this ApplicationWindowOptionsKit.

Param out_platform_data

The platform specific data for this ApplicationWindowOptionsKit.

Return

true if platform specific data 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.ApplicationWindowOptionsKit UnsetAntiAliasCapable ()

Removes the anti-alias options for this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit UnsetDriver ()

Removes the driver for this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit UnsetEverything ()

Removes all settings from this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit UnsetFramebufferRetention ()

Removes the framebuffer retention setting for this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit UnsetPlatformData ()

Removes the platform specific data for this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit UnsetPreferredGPU ()

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

Return

A reference to this ApplicationWindowOptionsKit.

HPS.ApplicationWindowOptionsKit UnsetScreenAntiAliasing ()

Removes the screen anti-alias options for this ApplicationWindowOptionsKit.

Return

A reference to this ApplicationWindowOptionsKit.

Public Static Functions

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

Return

An ApplicationWindowOptionsKit with the default settings.

bool operator!= (HPS.ApplicationWindowOptionsKit a, HPS.ApplicationWindowOptionsKit b)

bool operator== (HPS.ApplicationWindowOptionsKit a, HPS.ApplicationWindowOptionsKit b)