StandAloneWindowOptionsKit

class 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

virtual bool Empty() const

Indicates whether this StandAloneWindowOptionsKit has any values set on it.

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

bool Equals(StandAloneWindowOptionsKit const &in_kit) const

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters:	in_kit – The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns:	true if the objects are equivalent, false otherwise.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(StandAloneWindowOptionsKit const &in_kit) const

Check if the source StandAloneWindowOptionsKit is not equivalent to this StandAloneWindowOptionsKit.

Parameters:	in_kit – The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns:	true if the objects are not equivalent, false otherwise.

StandAloneWindowOptionsKit &operator=(StandAloneWindowOptionsKit &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this StandAloneWindowOptionsKit thereby avoiding a copy.

Parameters:	in_that – An rvalue reference to a StandAloneWindowOptionsKit to take the impl from.
Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &operator=(StandAloneWindowOptionsKit const &in_kit)

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters:	in_kit – The source StandAloneWindowOptionsKit to copy.
Returns:	A reference to this StandAloneWindowOptionsKit.

bool operator==(StandAloneWindowOptionsKit const &in_kit) const

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters:	in_kit – The source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns:	true if the objects are equivalent, false otherwise.

void Set(StandAloneWindowOptionsKit const &in_kit)

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters:	in_kit – The source StandAloneWindowOptionsKit to copy.

StandAloneWindowOptionsKit &SetAntiAliasCapable(bool in_state, unsigned int in_samples = 4)

Sets the anti-alias options for this StandAloneWindowOptionsKit.

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

StandAloneWindowOptionsKit &SetDriver(Window::Driver in_driver)

Sets the driver for this StandAloneWindowOptionsKit.

Parameters:	in_driver – The driver for this StandAloneWindowOptionsKit.
Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &SetFullScreen(bool in_state)

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

Parameters:	in_state – Whether the associated stand-alone window should fill the screen.
Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &SetMobility(Window::Mobility in_mobility)

Sets the mobility for this StandAloneWindowOptionsKit.

Parameters:	in_mobility – The mobility for this StandAloneWindowOptionsKit.
Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &SetPreferredGPU(GPU::Preference in_gpu_preference, char const *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. in_gpu_name needs to be specified when in_gpu_preference is set to GPU::Preference::Specific. The value passed for in_gpu_name needs to match one of those returned by Database::ShowAvailableGPUs(). 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 SetPreferredGPU(GPU::Preference::Specific, "Microsoft Basic Render Driver")), 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 `StandAloneWindowOptionsKit`.

StandAloneWindowOptionsKit &SetScreenAntiAliasing(bool in_state)

Manipulates the state of screen anti-aliasing.

Parameters:	in_state – Whether screen anti-aliasing should be used.
Returns:	A reference to this object.

StandAloneWindowOptionsKit &SetSubscreen(Rectangle const &in_subscreen)

Sets the subscreen to render into for this StandAloneWindowOptionsKit.

Parameters:	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.
Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &SetTitle(char const *in_window_name)

Sets the title for this StandAloneWindowOptionsKit.

Parameters:	in_window_name – UTF8-encoded title for this StandAloneWindowOptionsKit.
Returns:	A reference to this StandAloneWindowOptionsKit.

void Show(StandAloneWindowOptionsKit &out_kit) const

Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.

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

bool ShowAntiAliasCapable(bool &out_state, unsigned int &out_samples) const

Shows the anti-alias options for this StandAloneWindowOptionsKit.

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

bool ShowDriver(Window::Driver &out_driver) const

Shows the driver for this StandAloneWindowOptionsKit.

Parameters:	out_driver – The driver for this StandAloneWindowOptionsKit.
Returns:	true if a driver was set, false otherwise.

bool ShowFullScreen(bool &out_state) const

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

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

bool ShowMobility(Window::Mobility &out_mobility) const

Shows the mobility for this StandAloneWindowOptionsKit.

Parameters:	out_mobility – The mobility for this StandAloneWindowOptionsKit.
Returns:	true if a mobility was set, false otherwise.

bool ShowPreferredGPU(GPU::Preference &out_gpu_preference, HPS::UTF8 &out_gpu_name) const

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.

bool ShowSubscreen(Rectangle &out_subscreen) const

Shows the subscreen for this StandAloneWindowOptionsKit.

Parameters:	out_subscreen – The subscreen for this StandAloneWindowOptionsKit.
Returns:	true if a subscreen was set, false otherwise.

bool ShowTitle(UTF8 &out_window_name) const

Shows the title for this StandAloneWindowOptionsKit.

Parameters:	out_window_name – UTF8-encoded title for this StandAloneWindowOptionsKit.
Returns:	true if a title was set, false otherwise.

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

StandAloneWindowOptionsKit(StandAloneWindowOptionsKit &&in_that)

The move constructor creates a StandAloneWindowOptionsKit by transferring the underlying impl of the rvalue reference to this StandAloneWindowOptionsKit thereby avoiding a copy and allocation.

Parameters:	in_that – An rvalue reference to a StandAloneWindowOptionsKit to take the impl from.

StandAloneWindowOptionsKit(StandAloneWindowOptionsKit const &in_kit)

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

Parameters:	in_kit – The source StandAloneWindowOptionsKit to copy.

StandAloneWindowOptionsKit &UnsetAntiAliasCapable()

Removes the anti-alias options for this StandAloneWindowOptionsKit.

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetDriver()

Removes the driver for this StandAloneWindowOptionsKit.

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetEverything()

Removes all settings from this StandAloneWindowOptionsKit.

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetFullScreen()

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

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetMobility()

Removes the mobility for this StandAloneWindowOptionsKit.

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetPreferredGPU()

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

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetScreenAntiAliasing()

Removes the screen anti-alias options for this StandAloneWindowOptionsKit.

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetSubscreen()

Removes the subscreen for this StandAloneWindowOptionsKit.

Returns:	A reference to this StandAloneWindowOptionsKit.

StandAloneWindowOptionsKit &UnsetTitle()

Removes the title for this StandAloneWindowOptionsKit.

Returns:	A reference to this StandAloneWindowOptionsKit.

virtual ~StandAloneWindowOptionsKit()

Public Static Functions

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

Returns:	An StandAloneWindowOptionsKit with the default settings.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::StandAloneWindowOptionsKit