PixelShaderKit

class HPS::PixelShaderKit : public HPS::Kit 

The PixelShaderKit class is a user space object. It is used for specifying all settings related to a PixelShaderKey.

Public Functions

virtual bool Empty() const

Indicates whether this PixelShaderKit has any values set on it.

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

bool Equals(PixelShaderKit const &in_kit) const

Check if the source PixelShaderKit is equivalent to this PixelShaderKit.

Parameters: in_kit – The source PixelShaderKit to compare to this PixelShaderKit.
Returns: true if the objects are equivalent, false otherwise.

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.

bool operator!=(PixelShaderKit const &in_kit) const

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

Parameters: in_kit – The source PixelShaderKit to compare to this PixelShaderKit.
Returns: true if the objects are not equivalent, false otherwise.

PixelShaderKit &operator=(PixelShaderKit &&in_that)

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

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

PixelShaderKit &operator=(PixelShaderKit const &in_kit)

Copies the source PixelShaderKit into this PixelShaderKit.

Parameters: in_kit – The source PixelShaderKit to copy.
Returns: A reference to this PixelShaderKit.

bool operator==(PixelShaderKit const &in_kit) const

Check if the source PixelShaderKit is equivalent to this PixelShaderKit.

Parameters: in_kit – The source PixelShaderKit to compare to this PixelShaderKit.
Returns: true if the objects are equivalent, false otherwise.

PixelShaderKit(): The default constructor creates an empty PixelShaderKit object.

PixelShaderKit(PixelShaderKit &&in_that)

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

Parameters: in_that – An rvalue reference to a PixelShaderKit to take the impl from.

PixelShaderKit(PixelShaderKit const &in_kit)

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

Parameters: in_kit – The source PixelShaderKit to copy.

void Set(PixelShaderKit const &in_kit)

Copies the source PixelShaderKit into this PixelShaderKit.

Parameters: in_kit – The source PixelShaderKit to copy.

PixelShaderKit &SetInputs(HPS::Shader::PixelInputs in_inputs)

Sets the input flags for the shader.

Parameters: in_inputs – The input flags for the shader.
Returns: A reference to this PixelShaderKit.

PixelShaderKit &SetName(char const *in_name)

Sets the name of the shader.

Parameters: in_name – The name of the shader.
Returns: A reference to this PixelShaderKit.

PixelShaderKit &SetSource(char const *in_source)

Sets the source code for the shader.

Parameters: in_source – The source code for the shader.
Returns: A reference to this PixelShaderKit.

PixelShaderKit &SetUniforms(HPS::ShaderUniformArray const &in_uniforms)

Sets the uniform data types for the shader.

Parameters: in_uniforms – One or more ShaderUniform classes defining the data for the shader.
Returns: A reference to this PixelShaderKit.

void Show(PixelShaderKit &out_kit) const

Copies this PixelShaderKit into the given PixelShaderKit.

Parameters: out_kit – The PixelShaderKit to populate with the contents of this PixelShaderKit.

bool ShowInputs(HPS::Shader::PixelInputs &out_inputs) const

Shows the input flags for the shader.

Parameters: out_inputs – The input flags for the shader.
Returns: true if the source code is valid, false otherwise.

bool ShowName(UTF8 &out_name) const

Shows the name of the shader.

Parameters: out_name – The name of the shader.
Returns: true if the source code is valid, false otherwise.

bool ShowSource(UTF8 &out_source) const

Shows the source code for the shader.

Parameters: out_source – The source code for the shader.
Returns: true if the source code is valid, false otherwise.

bool ShowUniforms(HPS::ShaderUniformArray &out_uniforms) const

Shows the uniform data types for the shader.

Parameters: out_uniforms – The uniform data types for the shader.
Returns: true if the source code is valid, false otherwise.

PixelShaderKit &UnsetEverything()

Removes all settings from this PixelShaderKit.

Returns: A reference to this PixelShaderKit.

PixelShaderKit &UnsetInputs()

Removes the input flags for the shader.

Returns: A reference to this PixelShaderKit.

PixelShaderKit &UnsetName()

Removes the name of the shader.

Returns: A reference to this PixelShaderKit.

PixelShaderKit &UnsetSource()

Removes the source code for the shader.

Returns: A reference to this PixelShaderKit.

PixelShaderKit &UnsetUniforms()

Removes the uniform data types for the shader.

Returns: A reference to this PixelShaderKit.

virtual ~PixelShaderKit()

Public Static Attributes

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