StandAloneWindowOptionsKit

class HPS.StandAloneWindowOptionsKit : public HPS.Kit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this StandAloneWindowOptionsKit has any values set on it.

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

bool Equals (HPS.StandAloneWindowOptionsKit in_kit)

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Param in_kit: The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
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.StandAloneWindowOptionsKit in_kit)

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Param in_kit: The source StandAloneWindowOptionsKit to copy.

HPS.StandAloneWindowOptionsKit SetAntiAliasCapable (bool in_state)

Sets the anti-alias options for this StandAloneWindowOptionsKit.

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

HPS.StandAloneWindowOptionsKit SetAntiAliasCapable (bool in_state, uint in_samples)

Sets the anti-alias options for this StandAloneWindowOptionsKit.

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 stand-alone window. Defaults to 4.
Return: A reference to this StandAloneWindowOptionsKit.

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

Sets the driver for this StandAloneWindowOptionsKit.

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

HPS.StandAloneWindowOptionsKit SetFullScreen (bool in_state)

Sets whether the associated stand-alone window should fill the screen.

Param in_state: Whether the associated stand-alone window should fill the screen.
Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit SetMobility (HPS.Window.Mobility in_mobility)

Sets the mobility for this StandAloneWindowOptionsKit.

Param in_mobility: The mobility for this StandAloneWindowOptionsKit.
Return: A reference to this StandAloneWindowOptionsKit.

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

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

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

HPS.StandAloneWindowOptionsKit SetSubscreen (HPS.Rectangle in_subscreen)

Sets the subscreen to render into for this StandAloneWindowOptionsKit.

Param in_subscreen: The subscreen to render into for this StandAloneWindowOptionsKit. The units of the Rectangle are in window space, so -1.0f corresponds to the left (or bottom) of the window and 1.0f corresponds to the right (or top) of the window.
Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit SetTitle (string in_window_name)

Sets the title for this StandAloneWindowOptionsKit.

Param in_window_name: UTF8-encoded title for this StandAloneWindowOptionsKit.
Return: A reference to this StandAloneWindowOptionsKit.

void Show (out HPS.StandAloneWindowOptionsKit out_kit)

Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.

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

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

Shows the anti-alias options for this StandAloneWindowOptionsKit.

Param out_state: Whether the associated stand-alone window should be anti-alias capable.
Param out_samples: The number of anti-alias samples to use for the stand-alone 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 StandAloneWindowOptionsKit.

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

bool ShowFullScreen (out bool out_state)

Shows whether the associated stand-alone window should fill the screen.

Param out_state: Whether the associated stand-alone window should fill the screen.
Return: true if a full screen flag was set, false otherwise.

bool ShowMobility (out HPS.Window.Mobility out_mobility)

Shows the mobility for this StandAloneWindowOptionsKit.

Param out_mobility: The mobility for this StandAloneWindowOptionsKit.
Return: true if a mobility 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.

bool ShowSubscreen (out HPS.Rectangle out_subscreen)

Shows the subscreen for this StandAloneWindowOptionsKit.

Param out_subscreen: The subscreen for this StandAloneWindowOptionsKit.
Return: true if a subscreen was set, false otherwise.

bool ShowTitle (out string out_window_name)

Shows the title for this StandAloneWindowOptionsKit.

Param out_window_name: UTF8-encoded title for this StandAloneWindowOptionsKit.
Return: true if a title was set, false otherwise.

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

StandAloneWindowOptionsKit (HPS.StandAloneWindowOptionsKit in_kit)

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

Param in_kit: The source StandAloneWindowOptionsKit to copy.

HPS.StandAloneWindowOptionsKit UnsetAntiAliasCapable ()

Removes the anti-alias options for this StandAloneWindowOptionsKit.

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetDriver ()

Removes the driver for this StandAloneWindowOptionsKit.

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetEverything ()

Removes all settings from this StandAloneWindowOptionsKit.

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetFullScreen ()

Removes whether the associated stand-alone window should fill the screen.

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetMobility ()

Removes the mobility for this StandAloneWindowOptionsKit.

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetPreferredGPU ()

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

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetScreenAntiAliasing ()

Removes the screen anti-alias options for this StandAloneWindowOptionsKit.

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetSubscreen ()

Removes the subscreen for this StandAloneWindowOptionsKit.

Return: A reference to this StandAloneWindowOptionsKit.

HPS.StandAloneWindowOptionsKit UnsetTitle ()

Removes the title for this StandAloneWindowOptionsKit.

Return: A reference to this StandAloneWindowOptionsKit.

Public Static Functions

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

Return: An StandAloneWindowOptionsKit with the default settings.

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

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