LegacyShaderDefinition

class HPS::LegacyShaderDefinition : public HPS::Definition

Internal use only - customers should not use. The LegacyShaderDefinition class is a smart pointer to a database object. It is a handle to a shader defined within a portfolio.

Public Functions

LegacyShaderDefinition()

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

LegacyShaderDefinition(Definition const &in_that)

This constructor creates a LegacyShaderDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a shader definition. Otherwise the copy will fail and the resulting LegacyShaderDefinition will be invalid.

Parameters

in_that – The source Definition to copy.

LegacyShaderDefinition(LegacyShaderDefinition &&in_that)

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

Parameters

in_that – An rvalue reference to a LegacyShaderDefinition to take the impl from.

LegacyShaderDefinition(LegacyShaderDefinition const &in_that)

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

Parameters

in_that – The source LegacyShaderDefinition to copy.

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.

LegacyShaderDefinition &operator=(LegacyShaderDefinition &&in_that)

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

Parameters

in_that – An rvalue reference to a LegacyShaderDefinition to take the impl from.

Returns

A reference to this LegacyShaderDefinition.

LegacyShaderDefinition &operator=(LegacyShaderDefinition const &in_that)

Associate this LegacyShaderDefinition with the same underlying impl as the source LegacyShaderDefinition.

Parameters

in_that – The source LegacyShaderDefinition for the assignment.

Returns

A reference to this LegacyShaderDefinition.

void Set(LegacyShaderKit const &in_kit)

Redefine the shader for this LegacyShaderDefinition.

Parameters

in_kit – The new shader for this LegacyShaderDefinition.

void Show(LegacyShaderKit &out_kit) const

Shows the shader for this LegacyShaderDefinition.

Parameters

out_kit – The shader for this LegacyShaderDefinition.

~LegacyShaderDefinition()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::LegacyShaderDefinition