texture.h

Go to the documentation of this file.

/*!****************************************************************//*!*
 * \file   texture.h
 * \brief  Texture interface definition module.
 * 
 * \author Sabitov Kirill
 * \date   28 June 2022
 *********************************************************************/
 
#pragma once
 
#include "render_primitive.h"
#include "utilities/image/image.h"
 
namespace scl
{
    enum class texture_type
    {
        COLOR,                   
        COLOR_FLOATING_POINT,    
        DEPTH,                   
    };
 
    class texture_2d : public render_primitive
    {
    protected: 
        int Width {}, Height {};
 
    public: 
        int GetWidth() const { return Width; }
        int GetHeight() const { return Height; }
 
    public:
        virtual ~texture_2d() = default;
 
        /*!*
         * Bind texture to current render stage function.
         *
         * \param Slot - texture slot to bind it in.
         * \return None.
         */
        virtual void Bind(u32 Slot) const = 0;
 
        /*!*
         * Unbind texture from current render stage function.
         * 
         * \param Slot - texture slot to unbind it from.
         * \return None.
         */
        virtual void Unbind() const = 0;
 
        /*!*
         * Load texture image from GPU memory function.
         * 
         * \param None.
         * \return texture image.
         */
        virtual image GetImage() = 0;
 
        /*!*
         * Unload texture from GPU memory function.
         *
         * \param None.
         * \return None.
         */
        virtual void Free() = 0;
 
        /*!*
         * Create texture from image container function.
         *
         * \param Image - image container to get data from.
         * \return created texture pointer.
         */
        static shared<texture_2d> Create(const image &Image, texture_type Type = texture_type::COLOR);
    };
}