#include <hps.h>

Inheritance diagram for HPS::StandAloneWindowOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (StandAloneWindowOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (StandAloneWindowOptionsKit const &in_kit) const
 
StandAloneWindowOptionsKitoperator= (StandAloneWindowOptionsKit &&in_that)
 
StandAloneWindowOptionsKitoperator= (StandAloneWindowOptionsKit const &in_kit)
 
bool operator== (StandAloneWindowOptionsKit const &in_kit) const
 
void Set (StandAloneWindowOptionsKit const &in_kit)
 
StandAloneWindowOptionsKitSetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
 
StandAloneWindowOptionsKitSetDriver (Window::Driver in_driver)
 
StandAloneWindowOptionsKitSetFullScreen (bool in_state)
 
StandAloneWindowOptionsKitSetMobility (Window::Mobility in_mobility)
 
StandAloneWindowOptionsKitSetPreferredGPU (GPU::Preference in_gpu_preference, char const *in_gpu_name="")
 
StandAloneWindowOptionsKitSetScreenAntiAliasing (bool in_state)
 
StandAloneWindowOptionsKitSetSubscreen (Rectangle const &in_subscreen)
 
StandAloneWindowOptionsKitSetTitle (char const *in_window_name)
 
void Show (StandAloneWindowOptionsKit &out_kit) const
 
bool ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
 
bool ShowDriver (Window::Driver &out_driver) const
 
bool ShowFullScreen (bool &out_state) const
 
bool ShowMobility (Window::Mobility &out_mobility) const
 
bool ShowPreferredGPU (GPU::Preference &out_gpu_preference, HPS::UTF8 &out_gpu_name) const
 
bool ShowSubscreen (Rectangle &out_subscreen) const
 
bool ShowTitle (UTF8 &out_window_name) const
 
 StandAloneWindowOptionsKit ()
 
 StandAloneWindowOptionsKit (StandAloneWindowOptionsKit const &in_kit)
 
 StandAloneWindowOptionsKit (StandAloneWindowOptionsKit &&in_that)
 
StandAloneWindowOptionsKitUnsetAntiAliasCapable ()
 
StandAloneWindowOptionsKitUnsetDriver ()
 
StandAloneWindowOptionsKitUnsetEverything ()
 
StandAloneWindowOptionsKitUnsetFullScreen ()
 
StandAloneWindowOptionsKitUnsetMobility ()
 
StandAloneWindowOptionsKitUnsetPreferredGPU ()
 
StandAloneWindowOptionsKitUnsetScreenAntiAliasing ()
 
StandAloneWindowOptionsKitUnsetSubscreen ()
 
StandAloneWindowOptionsKitUnsetTitle ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static StandAloneWindowOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::StandAloneWindowOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ StandAloneWindowOptionsKit() [1/3]

HPS::StandAloneWindowOptionsKit::StandAloneWindowOptionsKit ( )

The default constructor creates an empty StandAloneWindowOptionsKit object.

◆ StandAloneWindowOptionsKit() [2/3]

HPS::StandAloneWindowOptionsKit::StandAloneWindowOptionsKit ( StandAloneWindowOptionsKit const &  in_kit)

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

Parameters
in_kitThe source StandAloneWindowOptionsKit to copy.

◆ StandAloneWindowOptionsKit() [3/3]

HPS::StandAloneWindowOptionsKit::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_thatAn rvalue reference to a StandAloneWindowOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::StandAloneWindowOptionsKit::Empty ( ) const
virtual

Indicates whether this StandAloneWindowOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::StandAloneWindowOptionsKit::Equals ( StandAloneWindowOptionsKit const &  in_kit) const

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static StandAloneWindowOptionsKit HPS::StandAloneWindowOptionsKit::GetDefault ( )
static

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.

◆ ObjectType()

HPS::Type HPS::StandAloneWindowOptionsKit::ObjectType ( ) const
inlinevirtual

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.

Reimplemented from HPS::Kit.

◆ operator!=()

bool HPS::StandAloneWindowOptionsKit::operator!= ( StandAloneWindowOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

StandAloneWindowOptionsKit& HPS::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_thatAn rvalue reference to a StandAloneWindowOptionsKit to take the impl from.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ operator=() [2/2]

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::operator= ( StandAloneWindowOptionsKit const &  in_kit)

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to copy.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ operator==()

bool HPS::StandAloneWindowOptionsKit::operator== ( StandAloneWindowOptionsKit const &  in_kit) const

Check if the source StandAloneWindowOptionsKit is equivalent to this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to compare to this StandAloneWindowOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::StandAloneWindowOptionsKit::Set ( StandAloneWindowOptionsKit const &  in_kit)

Copies the source StandAloneWindowOptionsKit into this StandAloneWindowOptionsKit.

Parameters
in_kitThe source StandAloneWindowOptionsKit to copy.

◆ SetAntiAliasCapable()

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

Sets the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
in_stateWhether the associated application window should be anti-alias capable.
in_samplesThe number of anti-alias samples to use for the associated stand-alone window. Defaults to 4.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetDriver()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetDriver ( Window::Driver  in_driver)

Sets the driver for this StandAloneWindowOptionsKit.

Parameters
in_driverThe driver for this StandAloneWindowOptionsKit.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetFullScreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetFullScreen ( bool  in_state)

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

Parameters
in_stateWhether the associated stand-alone window should fill the screen.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetMobility()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetMobility ( Window::Mobility  in_mobility)

Sets the mobility for this StandAloneWindowOptionsKit.

Parameters
in_mobilityThe mobility for this StandAloneWindowOptionsKit.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetPreferredGPU()

StandAloneWindowOptionsKit& HPS::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_preferenceWhich GPU to choose. If GPU::Preference::Specific is chosen, the next argument is required.
in_gpu_nameThe name of the specific GPU to use. Required when in_gpu_preference is GPU::Preference::Specific, ignored otherwise.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ SetScreenAntiAliasing()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetScreenAntiAliasing ( bool  in_state)

Manipulates the state of screen anti-aliasing.

Parameters
in_stateWhether screen anti-aliasing should be used.
Returns
A reference to this object.

◆ SetSubscreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetSubscreen ( Rectangle const &  in_subscreen)

Sets the subscreen to render into for this StandAloneWindowOptionsKit.

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

◆ SetTitle()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::SetTitle ( char const *  in_window_name)

Sets the title for this StandAloneWindowOptionsKit.

Parameters
in_window_nameUTF8-encoded title for this StandAloneWindowOptionsKit.
Returns
A reference to this StandAloneWindowOptionsKit.

◆ Show()

void HPS::StandAloneWindowOptionsKit::Show ( StandAloneWindowOptionsKit out_kit) const

Copies this StandAloneWindowOptionsKit into the given StandAloneWindowOptionsKit.

Parameters
out_kitThe StandAloneWindowOptionsKit to populate with the contents of this StandAloneWindowOptionsKit.

◆ ShowAntiAliasCapable()

bool HPS::StandAloneWindowOptionsKit::ShowAntiAliasCapable ( bool &  out_state,
unsigned int &  out_samples 
) const

Shows the anti-alias options for this StandAloneWindowOptionsKit.

Parameters
out_stateWhether the associated stand-alone window should be anti-alias capable.
out_samplesThe number of anti-alias samples to use for the stand-alone application window.
Returns
true if anti-alias options were set, false otherwise.

◆ ShowDriver()

bool HPS::StandAloneWindowOptionsKit::ShowDriver ( Window::Driver out_driver) const

Shows the driver for this StandAloneWindowOptionsKit.

Parameters
out_driverThe driver for this StandAloneWindowOptionsKit.
Returns
true if a driver was set, false otherwise.

◆ ShowFullScreen()

bool HPS::StandAloneWindowOptionsKit::ShowFullScreen ( bool &  out_state) const

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

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

◆ ShowMobility()

bool HPS::StandAloneWindowOptionsKit::ShowMobility ( Window::Mobility out_mobility) const

Shows the mobility for this StandAloneWindowOptionsKit.

Parameters
out_mobilityThe mobility for this StandAloneWindowOptionsKit.
Returns
true if a mobility was set, false otherwise.

◆ ShowPreferredGPU()

bool HPS::StandAloneWindowOptionsKit::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_preferenceThe preference for picking a GPU when multiple GPUs are available.
out_gpu_nameThe 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.

◆ ShowSubscreen()

bool HPS::StandAloneWindowOptionsKit::ShowSubscreen ( Rectangle out_subscreen) const

Shows the subscreen for this StandAloneWindowOptionsKit.

Parameters
out_subscreenThe subscreen for this StandAloneWindowOptionsKit.
Returns
true if a subscreen was set, false otherwise.

◆ ShowTitle()

bool HPS::StandAloneWindowOptionsKit::ShowTitle ( UTF8 out_window_name) const

Shows the title for this StandAloneWindowOptionsKit.

Parameters
out_window_nameUTF8-encoded title for this StandAloneWindowOptionsKit.
Returns
true if a title was set, false otherwise.

◆ UnsetAntiAliasCapable()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetAntiAliasCapable ( )

Removes the anti-alias options for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetDriver()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetDriver ( )

Removes the driver for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetEverything()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetEverything ( )

Removes all settings from this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetFullScreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetFullScreen ( )

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

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetMobility()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetMobility ( )

Removes the mobility for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetPreferredGPU()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetPreferredGPU ( )

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

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetScreenAntiAliasing()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetScreenAntiAliasing ( )

Removes the screen anti-alias options for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetSubscreen()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetSubscreen ( )

Removes the subscreen for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

◆ UnsetTitle()

StandAloneWindowOptionsKit& HPS::StandAloneWindowOptionsKit::UnsetTitle ( )

Removes the title for this StandAloneWindowOptionsKit.

Returns
A reference to this StandAloneWindowOptionsKit.

The documentation for this class was generated from the following file: