#include <hps.h>

Inheritance diagram for HPS::OffScreenWindowOptionsKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (OffScreenWindowOptionsKit const &in_kit) const
 
HPS::Type ObjectType () const
 
 OffScreenWindowOptionsKit ()
 
 OffScreenWindowOptionsKit (OffScreenWindowOptionsKit const &in_kit)
 
 OffScreenWindowOptionsKit (OffScreenWindowOptionsKit &&in_that)
 
bool operator!= (OffScreenWindowOptionsKit const &in_kit) const
 
OffScreenWindowOptionsKitoperator= (OffScreenWindowOptionsKit &&in_that)
 
OffScreenWindowOptionsKitoperator= (OffScreenWindowOptionsKit const &in_kit)
 
bool operator== (OffScreenWindowOptionsKit const &in_kit) const
 
void Set (OffScreenWindowOptionsKit const &in_kit)
 
OffScreenWindowOptionsKitSetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
 
OffScreenWindowOptionsKitSetDriver (Window::Driver in_driver)
 
OffScreenWindowOptionsKitSetFramebufferRetention (bool in_retain)
 
OffScreenWindowOptionsKitSetHardwareResident (bool in_state)
 
OffScreenWindowOptionsKitSetNativeFormat (Window::ImageFormat in_format, float in_quality=1.0f)
 
OffScreenWindowOptionsKitSetOpacity (bool in_state, float in_opacity=1.0f)
 
OffScreenWindowOptionsKitSetOpacity (float in_opacity)
 
OffScreenWindowOptionsKitSetPreferredGPU (GPU::Preference in_gpu_preference, char const *in_gpu_name="")
 
OffScreenWindowOptionsKitSetScreenAntiAliasing (bool in_state)
 
void Show (OffScreenWindowOptionsKit &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 ShowHardwareResident (bool &out_state) const
 
bool ShowNativeFormat (Window::ImageFormat &out_format, float &out_quality) const
 
bool ShowOpacity (bool &out_state, float &out_opacity) const
 
bool ShowPreferredGPU (GPU::Preference &out_gpu_preference, HPS::UTF8 &out_gpu_name) const
 
OffScreenWindowOptionsKitUnsetAntiAliasCapable ()
 
OffScreenWindowOptionsKitUnsetDriver ()
 
OffScreenWindowOptionsKitUnsetEverything ()
 
OffScreenWindowOptionsKitUnsetFramebufferRetention ()
 
OffScreenWindowOptionsKitUnsetHardwareResident ()
 
OffScreenWindowOptionsKitUnsetNativeFormat ()
 
OffScreenWindowOptionsKitUnsetOpacity ()
 
OffScreenWindowOptionsKitUnsetPreferredGPU ()
 
OffScreenWindowOptionsKitUnsetScreenAntiAliasing ()
 
- 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 OffScreenWindowOptionsKit 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::OffScreenWindowOptionsKit
 
- 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 HPS::OffScreenWindowOptionsKit class is a user space object. It is used to specify off-screen-window-specific options. Calling HPS::OffScreenWindowOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

◆ OffScreenWindowOptionsKit() [1/3]

HPS::OffScreenWindowOptionsKit::OffScreenWindowOptionsKit ( )

The default constructor creates an empty OffScreenWindowOptionsKit object.

◆ OffScreenWindowOptionsKit() [2/3]

HPS::OffScreenWindowOptionsKit::OffScreenWindowOptionsKit ( OffScreenWindowOptionsKit const &  in_kit)

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

Parameters
in_kitThe source OffScreenWindowOptionsKit to copy.

◆ OffScreenWindowOptionsKit() [3/3]

HPS::OffScreenWindowOptionsKit::OffScreenWindowOptionsKit ( OffScreenWindowOptionsKit &&  in_that)

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

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

Member Function Documentation

◆ Empty()

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

Indicates whether this OffScreenWindowOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit.

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

◆ GetDefault()

static OffScreenWindowOptionsKit HPS::OffScreenWindowOptionsKit::GetDefault ( )
static

Creates an OffScreenWindowOptionsKit 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 OffScreenWindowOptionsKit with the default settings.

◆ ObjectType()

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

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

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

◆ operator=() [1/2]

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

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

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

◆ operator=() [2/2]

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

Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.

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

◆ operator==()

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

Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit.

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

◆ Set()

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

Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.

Parameters
in_kitThe source OffScreenWindowOptionsKit to copy.

◆ SetAntiAliasCapable()

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

Sets the anti-alias options for this OffScreenWindowOptionsKit.

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

◆ SetDriver()

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

Sets the driver for this OffScreenWindowOptionsKit.

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

◆ SetFramebufferRetention()

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

Sets the framebuffer retention option for this OffScreenWindowOptionsKit.

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

◆ SetHardwareResident()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::SetHardwareResident ( bool  in_state)

Sets whether the image data for this offscreen window should be stored exclusively in video memory. Storing the image in video memory improves the update time but may make the image data inaccessible directly.

Parameters
in_stateWhether the image data for this offscreen window should be stored exclusively in video memory.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetNativeFormat()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::SetNativeFormat ( Window::ImageFormat  in_format,
float  in_quality = 1.0f 
)

Sets the native image format to store data in.

Parameters
in_formatFormat image data will be stored in.
in_qualityThe compression quality for the image data (when applicable).
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetOpacity() [1/2]

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::SetOpacity ( bool  in_state,
float  in_opacity = 1.0f 
)

Sets whether this offscreen window supports opacity in the window background and the opacity value that should be applied when rendering the window background.

Parameters
in_stateWhether this offscreen window should support opacity in the window background.
in_opacityThe opacity value that will be applied when rendering the window background. The value is clamped if the opacity is outside the range 0 to 1.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetOpacity() [2/2]

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::SetOpacity ( float  in_opacity)

Enables support for opacity in the window background and applies the specified opacity value when rendering the window background.

Parameters
in_opacityThe opacity value that will be applied when rendering the window background.
Returns
A reference to this OffScreenWindowOptionsKit.

◆ SetPreferredGPU()

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

◆ SetScreenAntiAliasing()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::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::OffScreenWindowOptionsKit::Show ( OffScreenWindowOptionsKit out_kit) const

Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit.

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

◆ ShowAntiAliasCapable()

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

Shows the anti-alias options for this OffScreenWindowOptionsKit.

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::OffScreenWindowOptionsKit::ShowDriver ( Window::Driver out_driver) const

Shows the driver for this OffScreenWindowOptionsKit.

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

◆ ShowFramebufferRetention()

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

Shows the framebuffer retention setting for this OffScreenWindowOptionsKit.

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

◆ ShowHardwareResident()

bool HPS::OffScreenWindowOptionsKit::ShowHardwareResident ( bool &  out_state) const

Shows the hardware resident option for this OffScreenWindowOptionsKit.

Parameters
out_stateWhether the image data for this offscreen window should be stored exclusively in video memory.
Returns
true if a hardware resident option was set, false otherwise.

◆ ShowNativeFormat()

bool HPS::OffScreenWindowOptionsKit::ShowNativeFormat ( Window::ImageFormat out_format,
float &  out_quality 
) const

Shows the native format option for this OffScreenWindowOptionsKit.

Parameters
out_formatFormat image data will be stored in.
out_qualityThe compression quality for the image data (when applicable).
Returns
true if a native format option was set, false otherwise.

◆ ShowOpacity()

bool HPS::OffScreenWindowOptionsKit::ShowOpacity ( bool &  out_state,
float &  out_opacity 
) const

Shows the opacity option for this offscreen window

Parameters
out_stateWhether this offscreen window supports opacity in the window background.
out_opacityThe opacity value that will be applied when rendering the window background.
Returns
true if an opacity option was set, false otherwise.

◆ ShowPreferredGPU()

bool HPS::OffScreenWindowOptionsKit::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()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetAntiAliasCapable ( )

Removes the anti-alias options for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetDriver()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetDriver ( )

Removes the driver for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetEverything()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetEverything ( )

Removes all settings from this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetFramebufferRetention()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetFramebufferRetention ( )

Removes the framebuffer retention setting for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetHardwareResident()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetHardwareResident ( )

Removes the hardware resident option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetNativeFormat()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetNativeFormat ( )

Removes the native format option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetOpacity()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetOpacity ( )

Removes the opacity option for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetPreferredGPU()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetPreferredGPU ( )

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

Returns
A reference to this OffScreenWindowOptionsKit.

◆ UnsetScreenAntiAliasing()

OffScreenWindowOptionsKit& HPS::OffScreenWindowOptionsKit::UnsetScreenAntiAliasing ( )

Removes the screen anti-alias options for this OffScreenWindowOptionsKit.

Returns
A reference to this OffScreenWindowOptionsKit.

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