# ShaderTextureKit

class `ShaderTextureKit` : public HPS::Kit

  ShaderTextureKit class is a user space object. It is used for specifying all settings related to a ShaderTextureKey.

  Public Functions

  virtual bool `Empty`() const

    Indicates whether this ShaderTextureKit has any values set on it.

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

  bool `Equals`(ShaderTextureKit const &in_kit) const

    Check if the source ShaderTextureKit is equivalent to this ShaderTextureKit.

    Parameters: | in_kit – The source ShaderTextureKit to compare to this ShaderTextureKit.
    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!=`(ShaderTextureKit const &in_kit) const

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

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

  ShaderTextureKit &`operator=`(ShaderTextureKit &&in_that)

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

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

  ShaderTextureKit &`operator=`(ShaderTextureKit const &in_kit)

    Copies the source ShaderTextureKit into this ShaderTextureKit.

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

  bool `operator==`(ShaderTextureKit const &in_kit) const

    Check if the source ShaderTextureKit is equivalent to this ShaderTextureKit.

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

  void `Set`(ShaderTextureKit const &in_kit)

    Copies the source ShaderTextureKit into this ShaderTextureKit.

    Parameters: | in_kit – The source ShaderTextureKit to copy.

  ShaderTextureKit &`SetData`(HPS::ByteArrayArray const &in_data)

    Sets the data for the texture.

    Parameters: | in_data – An array (currently only 1 allowed) of blocks of data defining the texture.
    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`SetFormat`(HPS::Shader::Texture::Format in_format)

    Sets the data format for the texture.

    Parameters: | in_format – The format of the data for the texture.
    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`SetMipmapLevels`(int in_levels)

    Sets the number of mipmap levels for the texture.

    Parameters: | in_levels – The number of mipmap levels for the texture.
    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`SetName`(char const *in_name)

    Sets the name for the texture.

    Parameters: | in_width – The name of the texture.

  ShaderTextureKit &`SetSize`(int in_width, int height, int in_depth = 1)

    Sets the size for the texture.

    Parameters: | in_width – The width of the texture. in_height – The height of the texture. in_depth – The depth of the texture (defaults to 1).
    Returns: | A reference to this ShaderTextureKit.

  `ShaderTextureKit`()

    The default constructor creates an empty ShaderTextureKit object.

  `ShaderTextureKit`(ShaderTextureKit &&in_that)

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

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

  `ShaderTextureKit`(ShaderTextureKit const &in_kit)

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

    Parameters: | in_kit – The source ShaderTextureKit to copy.

  void `Show`(ShaderTextureKit &out_kit) const

    Copies this ShaderTextureKit into the given ShaderTextureKit.

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

  bool `ShowData`(HPS::ByteArrayArray &out_data) const

    Shows the data for the texture.

    Parameters: | out_data – An array of pointers to the blocks of data defining the texture.
    Returns: | true if the data is valid, false otherwise.

  bool `ShowFormat`(HPS::Shader::Texture::Format &out_format) const

    Shows the format for the texture.

    Parameters: | out_format – The format for the texture.
    Returns: | true if the format is valid, false otherwise.

  bool `ShowMipmapLevels`(int &out_levels) const

    Shows the mipmap levels for the texture.

    Parameters: | out_levels – The mipmap levels for the texture.
    Returns: | true if the mipmap levels field is valid, false otherwise.

  bool `ShowName`(UTF8 &out_name) const

    Shows the name of the texture.

    Parameters: | out_name – The name the texture.
    Returns: | true if the name is valid, false otherwise.

  bool `ShowSize`(int &out_width, int &out_height) const

    Shows the size of the texture.

    Parameters: | out_width – The width the texture. out_height – The height the texture.
    Returns: | true if the size is valid, false otherwise.

  bool `ShowSize`(int &out_width, int &out_height, int &out_depth) const

    Shows the size of the texture.

    Parameters: | out_width – The width the texture. out_height – The height the texture. out_depth – The depth the texture.
    Returns: | true if the size is valid, false otherwise.

  ShaderTextureKit &`UnsetData`()

    Removes the data for the texture.

    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`UnsetEverything`()

    Removes all settings from this ShaderTextureKit.

    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`UnsetFormat`()

    Removes the format for the texture.

    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`UnsetMipmapLevels`()

    Removes the mipmap levels for the texture.

    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`UnsetName`()

    Removes the name for the texture.

    Returns: | A reference to this ShaderTextureKit.

  ShaderTextureKit &`UnsetSize`()

    Removes the size values for the texture.

    Returns: | A reference to this ShaderTextureKit.

  virtual `~ShaderTextureKit`()

  Public Static Attributes

  static const HPS::Type `staticType` = HPS::Type::ShaderTextureKit

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Visualize Desktop in your own language, or choose a sample question below to start a conversation:

What is HOOPS Visualize Desktop?
What are the latest release notes for HOOPS Visualize Desktop?
How do I start evaluating HOOPS Visualize Desktop?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...