#include <hps.h>

Inheritance diagram for HPS::ApplicationWindowOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

 ApplicationWindowOptionsKit ()
 
 ApplicationWindowOptionsKit (ApplicationWindowOptionsKit const &in_kit)
 
 ApplicationWindowOptionsKit (ApplicationWindowOptionsKit &&in_that)
 
bool Empty () const
 
bool Equals (ApplicationWindowOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (ApplicationWindowOptionsKit const &in_kit) const
 
ApplicationWindowOptionsKitoperator= (ApplicationWindowOptionsKit &&in_that)
 
ApplicationWindowOptionsKitoperator= (ApplicationWindowOptionsKit const &in_kit)
 
bool operator== (ApplicationWindowOptionsKit const &in_kit) const
 
void Set (ApplicationWindowOptionsKit const &in_kit)
 
ApplicationWindowOptionsKitSetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
 
ApplicationWindowOptionsKitSetDriver (Window::Driver in_driver)
 
ApplicationWindowOptionsKitSetFramebufferRetention (bool in_retain)
 
ApplicationWindowOptionsKitSetPlatformData (PlatformData in_platform_data)
 
ApplicationWindowOptionsKitSetPreferredGPU (GPU::Preference in_gpu_preference, char const *in_gpu_name="")
 
ApplicationWindowOptionsKitSetScreenAntiAliasing (bool in_state)
 
void Show (ApplicationWindowOptionsKit &out_kit) const
 
bool ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
 
bool ShowDriver (Window::Driver &out_driver) const
 
bool ShowFramebufferRetention (bool &out_retain) const
 
bool ShowPlatformData (PlatformData &out_platform_data) const
 
bool ShowPreferredGPU (GPU::Preference &out_gpu_preference, HPS::UTF8 &out_gpu_name) const
 
ApplicationWindowOptionsKitUnsetAntiAliasCapable ()
 
ApplicationWindowOptionsKitUnsetDriver ()
 
ApplicationWindowOptionsKitUnsetEverything ()
 
ApplicationWindowOptionsKitUnsetFramebufferRetention ()
 
ApplicationWindowOptionsKitUnsetPlatformData ()
 
ApplicationWindowOptionsKitUnsetPreferredGPU ()
 
ApplicationWindowOptionsKitUnsetScreenAntiAliasing ()
 
- 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 ApplicationWindowOptionsKit 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::ApplicationWindowOptionsKit
 
- 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 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.

Constructor & Destructor Documentation

◆ ApplicationWindowOptionsKit() [1/3]

HPS::ApplicationWindowOptionsKit::ApplicationWindowOptionsKit ( )

The default constructor creates an empty ApplicationWindowOptionsKit object.

◆ ApplicationWindowOptionsKit() [2/3]

HPS::ApplicationWindowOptionsKit::ApplicationWindowOptionsKit ( ApplicationWindowOptionsKit const &  in_kit)

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

Parameters
in_kitThe source ApplicationWindowOptionsKit to copy.

◆ ApplicationWindowOptionsKit() [3/3]

HPS::ApplicationWindowOptionsKit::ApplicationWindowOptionsKit ( ApplicationWindowOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ApplicationWindowOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

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

Indicates whether this ApplicationWindowOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.

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

◆ GetDefault()

static ApplicationWindowOptionsKit HPS::ApplicationWindowOptionsKit::GetDefault ( )
static

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.

Returns
An ApplicationWindowOptionsKit with the default settings.

◆ ObjectType()

HPS::Type HPS::ApplicationWindowOptionsKit::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::ApplicationWindowOptionsKit::operator!= ( ApplicationWindowOptionsKit const &  in_kit) const

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

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

◆ operator=() [1/2]

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::operator= ( ApplicationWindowOptionsKit &&  in_that)

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

Parameters
in_thatAn rvalue reference to an ApplicationWindowOptionsKit to take the impl from.
Returns
A reference to this ApplicationWindowOptionsKit.

◆ operator=() [2/2]

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

Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.

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

◆ operator==()

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

Check if the source ApplicationWindowOptionsKit is equivalent to this ApplicationWindowOptionsKit.

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

◆ Set()

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

Copies the source ApplicationWindowOptionsKit into this ApplicationWindowOptionsKit.

Parameters
in_kitThe source ApplicationWindowOptionsKit to copy.

◆ SetAntiAliasCapable()

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

Sets the anti-alias options for this ApplicationWindowOptionsKit.

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

◆ SetDriver()

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

Sets the driver for this ApplicationWindowOptionsKit.

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

◆ SetFramebufferRetention()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::SetFramebufferRetention ( bool  in_retain)

Sets the framebuffer retention option for this ApplicationWindowOptionsKit.

Parameters
in_retainWhether the associated application window retains the image from the previous frame.
Returns
A reference to this ApplicationWindowOptionsKit.

◆ SetPlatformData()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::SetPlatformData ( PlatformData  in_platform_data)

Sets the platform specific data for this ApplicationWindowOptionsKit.

Parameters
in_platform_dataPlatform specific data for this ApplicationWindowOptionsKit.
Returns
A reference to this ApplicationWindowOptionsKit.

◆ SetPreferredGPU()

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

◆ SetScreenAntiAliasing()

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

◆ Show()

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

Copies this ApplicationWindowOptionsKit into the given ApplicationWindowOptionsKit.

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

◆ ShowAntiAliasCapable()

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

Shows the anti-alias options for this ApplicationWindowOptionsKit.

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

◆ ShowDriver()

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

Shows the driver for this ApplicationWindowOptionsKit.

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

◆ ShowFramebufferRetention()

bool HPS::ApplicationWindowOptionsKit::ShowFramebufferRetention ( bool &  out_retain) const

Shows the framebuffer retention setting for this ApplicationWindowOptionsKit.

Parameters
out_retainThe framebuffer retention setting for this ApplicationWindowOptionsKit.
Returns
true if platform specific data was set, false otherwise.

◆ ShowPlatformData()

bool HPS::ApplicationWindowOptionsKit::ShowPlatformData ( PlatformData &  out_platform_data) const

Shows the platform specific data for this ApplicationWindowOptionsKit.

Parameters
out_platform_dataThe platform specific data for this ApplicationWindowOptionsKit.
Returns
true if platform specific data was set, false otherwise.

◆ ShowPreferredGPU()

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

◆ UnsetAntiAliasCapable()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetAntiAliasCapable ( )

Removes the anti-alias options for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetDriver()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetDriver ( )

Removes the driver for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetEverything()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetEverything ( )

Removes all settings from this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetFramebufferRetention()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetFramebufferRetention ( )

Removes the framebuffer retention setting for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetPlatformData()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetPlatformData ( )

Removes the platform specific data for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetPreferredGPU()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetPreferredGPU ( )

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

Returns
A reference to this ApplicationWindowOptionsKit.

◆ UnsetScreenAntiAliasing()

ApplicationWindowOptionsKit& HPS::ApplicationWindowOptionsKit::UnsetScreenAntiAliasing ( )

Removes the screen anti-alias options for this ApplicationWindowOptionsKit.

Returns
A reference to this ApplicationWindowOptionsKit.

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