OffScreenWindowKey

class HPS::OffScreenWindowKey : public HPS::WindowKey 

The OffScreenWindowKey class is a smart pointer to a database object. Offscreen windows are special types of windows that represent images that can be rendered into.

Public Functions

OffScreenWindowOptionsControl GetWindowOptionsControl()

Gets a control that allows querying options specific to offscreen windows.

Returns: A control that allows querying options specific to offscreen windows.

OffScreenWindowOptionsControl const GetWindowOptionsControl() const

Gets a control that allows querying options specific to offscreen windows.

Returns: A control that allows querying options specific to offscreen windows.

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.

OffScreenWindowKey(): The default constructor creates an uninitialized OffScreenWindowKey object. The Type() function will return Type::None.

OffScreenWindowKey(Key const &in_key)

The copy constructor creates an OffScreenWindowKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an offscreen window. Otherwise the copy will fail and the resulting OffScreenWindowKey will be invalid.

Parameters: in_key – The source Key to copy.

OffScreenWindowKey(OffScreenWindowKey &&in_that)

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

Parameters: in_that – An rvalue reference to an OffScreenWindowKey to take the impl from.

OffScreenWindowKey(OffScreenWindowKey const &in_that)

The copy constructor creates a OffScreenWindowKey object that shares the underlying smart-pointer of the source OffScreenWindowKey.

Parameters: in_that – The source OffScreenWindowKey to copy.

OffScreenWindowKey &operator=(OffScreenWindowKey &&in_that)

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

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

bool ShowWindowOptions(OffScreenWindowOptionsKit &out_kit) const

Shows the offscreen-window-specific options for this OffScreenWindowKey.

Parameters: out_kit – The offscreen-window-specific options for this OffScreenWindowKey.
Returns: true if any options are set, false otherwise.

~OffScreenWindowKey()

Public Static Attributes

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