scl::gl_texture_2d Class Reference

#include <gl_texture.h>

Inheritance diagram for scl::gl_texture_2d:

Public Member Functions
render_primitive::handle	GetHandle () const override
	gl_texture_2d (const image &Image, texture_type Type)
	~gl_texture_2d () override
void	Bind (u32 Slot) const override
void	Unbind () const override
void	Free () override
image	GetImage () override
Public Member Functions inherited from scl::texture_2d
int	GetWidth () const
int	GetHeight () const
virtual	~texture_2d ()=default
virtual void	Bind (u32 Slot) const =0
virtual void	Unbind () const =0
virtual image	GetImage ()=0
virtual void	Free ()=0

Additional Inherited Members
Static Public Member Functions inherited from scl::texture_2d
static shared< texture_2d >	Create (const image &Image, texture_type Type=texture_type::COLOR)
Protected Attributes inherited from scl::texture_2d
int	Width {}
int	Height {}

Detailed Description

Texture interface.

Definition at line 17 of file gl_texture.h.

Constructor & Destructor Documentation

gl_texture_2d()

scl::gl_texture_2d::gl_texture_2d	(	const image &	Image,
		texture_type	Type
	)

• OpenGL texture constructor by image container.

Parameters

Image	- image container to get data from (pixels data can be null).
Type	- texture type.

Returns

created texture pointer.

Definition at line 56 of file gl_texture.cpp.

{
    this->Width = Image.GetWidth();
    this->Height = Image.GetHeight();
 
    switch (Type)
    {
    case scl::texture_type::COLOR:                this->CreateColor(Image, false); SCL_CORE_SUCCES("OpenGL Color Texture with id {} created.", Id); return;
    case scl::texture_type::COLOR_FLOATING_POINT: this->CreateColor(Image, true);  SCL_CORE_SUCCES("OpenGL HDR Texture with id {} created.", Id); return;
    case scl::texture_type::DEPTH:                this->CreateDepth(Image);        SCL_CORE_SUCCES("OpenGL Depth Texture with id {} created.", Id); return;
    }
 
    SCL_CORE_ASSERT(0, "Unknown texture type.");
}

~gl_texture_2d()

scl::gl_texture_2d::~gl_texture_2d ( )

override

Texture default destructor.

Definition at line 71 of file gl_texture.cpp.

{
    Free();
}

Member Function Documentation

Bind()

void scl::gl_texture_2d::Bind ( u32  Slot ) const

overridevirtual

• Bind texture to current render stage function.

Parameters

None.

Returns

None.

Implements scl::texture_2d.

Definition at line 76 of file gl_texture.cpp.

{
    if (Id == 0) return;
 
    this->Slot = Slot;
    glActiveTexture(GL_TEXTURE0 + Slot);
    glBindTexture(GL_TEXTURE_2D, Id);
}

Free()

void scl::gl_texture_2d::Free ( )

overridevirtual

• Unload texture from GPU memory function.

Parameters

None.

Returns

None.

Implements scl::texture_2d.

Definition at line 91 of file gl_texture.cpp.

{
    if (Id == 0) return;
 
    glDeleteTextures(1, &Id);
    Id = 0;
}

GetHandle()

render_primitive::handle scl::gl_texture_2d::GetHandle ( ) const

inlineoverride

OpenGL texture getter/setter functions.

Backend api render primitive hadnle getter function.

Definition at line 25 of file gl_texture.h.

{ return Id; }

GetImage()

scl::image scl::gl_texture_2d::GetImage ( )

overridevirtual

• Load texture image from GPU memory function.

Parameters

None.

Returns

texture image.

Implements scl::texture_2d.

Definition at line 99 of file gl_texture.cpp.

{
    // TODO: Load image raw data from GPU and create image container from it.
    return image();
}

Unbind()

void scl::gl_texture_2d::Unbind ( ) const

overridevirtual

• Unbind texture from current render stage function.

Parameters

None.

Returns

None.

Implements scl::texture_2d.

Definition at line 85 of file gl_texture.cpp.

{
    glActiveTexture(GL_TEXTURE0 + this->Slot);
    glBindTexture(GL_TEXTURE_2D, 0);
}

---

The documentation for this class was generated from the following files:

• platform/opengl/gl_texture.h
• platform/opengl/gl_texture.cpp