#include <hps.h>

Inheritance diagram for HPS::OffScreenWindowOptionsKit:

Collaboration diagram for HPS::OffScreenWindowOptionsKit:

Public Member Functions
	OffScreenWindowOptionsKit ()
	The default constructor creates an empty OffScreenWindowOptionsKit object. More...

	OffScreenWindowOptionsKit (OffScreenWindowOptionsKit const &in_kit)
	The copy constructor creates a new OffScreenWindowOptionsKit object that contains the same settings as the source OffScreenWindowOptionsKit. More...

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

OffScreenWindowOptionsKit &	operator= (OffScreenWindowOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this OffScreenWindowOptionsKit thereby avoiding a copy. More...

virtual	~OffScreenWindowOptionsKit ()

HPS::Type	ObjectType () const

void	Set (OffScreenWindowOptionsKit const &in_kit)
	Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit. More...

void	Show (OffScreenWindowOptionsKit &out_kit) const
	Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	operator= (OffScreenWindowOptionsKit const &in_kit)
	Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit. More...

bool	Empty () const
	Indicates whether this OffScreenWindowOptionsKit has any values set on it. More...

bool	Equals (OffScreenWindowOptionsKit const &in_kit) const
	Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit. More...

bool	operator== (OffScreenWindowOptionsKit const &in_kit) const
	Check if the source OffScreenWindowOptionsKit is equivalent to this OffScreenWindowOptionsKit. More...

bool	operator!= (OffScreenWindowOptionsKit const &in_kit) const
	Check if the source OffScreenWindowOptionsKit is not equivalent to this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	SetDriver (Window::Driver in_driver)
	Sets the driver for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	SetAntiAliasCapable (bool in_state, unsigned int in_samples=4)
	Sets the anti-alias options for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	SetHardwareResident (bool in_state)
	Sets whether the image data for this offscreen window should be stored exclusively in video memory. More...

OffScreenWindowOptionsKit &	SetNativeFormat (Window::ImageFormat in_format, float in_quality=1.0f)
	Sets the native image format to store data in. More...

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

OffScreenWindowOptionsKit &	SetOpacity (float in_opacity)
	Enables support for opacity in the window background and applies the specified opacity value when rendering the window background. More...

OffScreenWindowOptionsKit &	SetFramebufferRetention (bool in_retain)
	Sets the framebuffer retention option for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	UnsetDriver ()
	Removes the driver for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	UnsetAntiAliasCapable ()
	Removes the anti-alias options for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	UnsetHardwareResident ()
	Removes the hardware resident option for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	UnsetNativeFormat ()
	Removes the native format option for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	UnsetOpacity ()
	Removes the opacity option for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	UnsetFramebufferRetention ()
	Removes the framebuffer retention setting for this OffScreenWindowOptionsKit. More...

OffScreenWindowOptionsKit &	UnsetEverything ()
	Removes all settings from this OffScreenWindowOptionsKit. More...

bool	ShowDriver (Window::Driver &out_driver) const
	Shows the driver for this OffScreenWindowOptionsKit. More...

bool	ShowAntiAliasCapable (bool &out_state, unsigned int &out_samples) const
	Shows the anti-alias options for this OffScreenWindowOptionsKit. More...

bool	ShowHardwareResident (bool &out_state) const
	Shows the hardware resident option for this OffScreenWindowOptionsKit. More...

bool	ShowNativeFormat (Window::ImageFormat &out_format, float &out_quality) const
	Shows the native format option for this OffScreenWindowOptionsKit. More...

bool	ShowOpacity (bool &out_state, float &out_opacity) const
	Shows the opacity option for this offscreen window. More...

bool	ShowFramebufferRetention (bool &out_retain) const
	Shows the framebuffer retention setting for this OffScreenWindowOptionsKit. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static OffScreenWindowOptionsKit	GetDefault ()
	Creates an OffScreenWindowOptionsKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::OffScreenWindowOptionsKit

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_kit The 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_that An rvalue reference to an OffScreenWindowOptionsKit to take the impl from.

◆ ~OffScreenWindowOptionsKit()

virtual HPS::OffScreenWindowOptionsKit::~OffScreenWindowOptionsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source OffScreenWindowOptionsKit to compare to this OffScreenWindowOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

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

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::OffScreenWindowOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The 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_that An 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_kit The 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_kit The source OffScreenWindowOptionsKit to compare to this OffScreenWindowOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source OffScreenWindowOptionsKit into this OffScreenWindowOptionsKit.

Parameters

in_kit The 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_state	Whether the associated application window should be anti-alias capable.
in_samples	The 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_driver The 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_retain Whether 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_state Whether 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_format	Format image data will be stored in.
in_quality	The 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_state	Whether this offscreen window should support opacity in the window background.
in_opacity	The 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_opacity The opacity value that will be applied when rendering the window background.

Returns: A reference to this OffScreenWindowOptionsKit.

◆ Show()

void HPS::OffScreenWindowOptionsKit::Show ( OffScreenWindowOptionsKit & out_kit ) const

Copies this OffScreenWindowOptionsKit into the given OffScreenWindowOptionsKit.

Parameters

out_kit The 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_state	Whether the associated application window should be anti-alias capable.
out_samples	The 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_driver The 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_retain The 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_state Whether 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_format	Format image data will be stored in.
out_quality	The 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_state	Whether this offscreen window supports opacity in the window background.
out_opacity	The opacity value that will be applied when rendering the window background.

Returns: true if an opacity option was set, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::OffScreenWindowOptionsKit::staticType = HPS::Type::OffScreenWindowOptionsKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OffScreenWindowOptionsKit() [1/3]

◆ OffScreenWindowOptionsKit() [2/3]

◆ OffScreenWindowOptionsKit() [3/3]

◆ ~OffScreenWindowOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetAntiAliasCapable()

◆ SetDriver()

◆ SetFramebufferRetention()

◆ SetHardwareResident()

◆ SetNativeFormat()

◆ SetOpacity() [1/2]

◆ SetOpacity() [2/2]

◆ Show()

◆ ShowAntiAliasCapable()

◆ ShowDriver()

◆ ShowFramebufferRetention()

◆ ShowHardwareResident()

◆ ShowNativeFormat()

◆ ShowOpacity()

◆ Type()

◆ UnsetAntiAliasCapable()

◆ UnsetDriver()

◆ UnsetEverything()

◆ UnsetFramebufferRetention()

◆ UnsetHardwareResident()

◆ UnsetNativeFormat()

◆ UnsetOpacity()

Member Data Documentation

◆ staticType