#include <SLGLDepthBuffer.h>

Inheritance diagram for SLGLDepthBuffer:

Public Member Functions
	SLGLDepthBuffer (const SLVec2i &dimensions, SLenum magFilter=GL_NEAREST, SLenum minFilter=GL_NEAREST, SLint wrap=GL_REPEAT, SLfloat borderColor[]=nullptr, SLenum target=GL_TEXTURE_2D, SLstring name="SM-DepthBuffer")

	~SLGLDepthBuffer ()

SLint	texID ()

SLint	target ()

void	bindActive (SLuint texUnit) const
	Sets the active texture unit within the shader and binds the texture. More...

void	bind ()
	Binds the OpenGL frame buffer object for the depth buffer. More...

void	unbind ()
	Ends the usage of the depth buffer frame buffer. More...

void	bindFace (SLenum face) const
	Binds a specific texture face of a cube map depth buffer. More...

SLfloat *	readPixels () const

SLVec2i	dimensions ()

Private Attributes
SLVec2i	_dimensions
	Size of the texture. More...

SLuint	_fboID
	ID of the FB object. More...

SLint	_prevFboID
	ID of the previously bound FB. More...

SLuint	_texID
	ID of the texture. More...

SLenum	_target
	GL_TEXTURE_2D or GL_TEXTURE_CUBE_MAP. More...

Private Attributes inherited from SLObject
SLstring	_name
	name of an object More...

SLstring	_url
	uniform resource locator More...

Additional Inherited Members
Private Member Functions inherited from SLObject
	SLObject (const SLstring &Name="", const SLstring &url="")

virtual	~SLObject ()

void	name (const SLstring &Name)

void	url (const SLstring &url)

const SLstring &	name () const

const SLstring &	url () const

Detailed Description

Definition at line 19 of file SLGLDepthBuffer.h.

Constructor & Destructor Documentation

◆ SLGLDepthBuffer()

SLGLDepthBuffer::SLGLDepthBuffer	(	const SLVec2i &	dimensions,
		SLenum	magFilter = `GL_NEAREST`,
		SLenum	minFilter = `GL_NEAREST`,
		SLint	wrap = `GL_REPEAT`,
		SLfloat	borderColor[] = `nullptr`,
		SLenum	target = `GL_TEXTURE_2D`,
		SLstring	name = `"SM-DepthBuffer"`
	)

Constructor for OpenGL depth buffer framebuffer used in shadow mapping

Parameters

dimensions	2D vector pixel dimensions
magFilter	OpenGL magnification filter enum
minFilter	OpenGL minification filter enum
wrap	OpenGL texture wrapping enum
borderColor
target	OpenGL texture target enum GL_TEXTURE_2D or GL_TEXTURE_CUBE_MAP
name	Name of the depth buffer

Definition at line 26 of file SLGLDepthBuffer.cpp.

   : SLObject(name),
     _dimensions(dimensions),
     _target(target)
 {
     PROFILE_FUNCTION();
  
     assert(target == GL_TEXTURE_2D || target == GL_TEXTURE_CUBE_MAP);
     SLGLState* stateGL = SLGLState::instance();
  
     // Init framebuffer.
     glGenFramebuffers(1, &_fboID);
     GET_GL_ERROR;
  
     bind();
  
     glGenTextures(1, &_texID);
     stateGL->bindTexture(target, _texID);
     GET_GL_ERROR;
  
     // Texture parameters.
     glTexParameteri(target, GL_TEXTURE_MIN_FILTER, minFilter);
     glTexParameteri(target, GL_TEXTURE_MAG_FILTER, magFilter);
     glTexParameteri(target, GL_TEXTURE_WRAP_S, wrap);
     glTexParameteri(target, GL_TEXTURE_WRAP_T, wrap);
  
 #ifndef SL_GLES
     if (borderColor != nullptr)
         glTexParameterfv(target, GL_TEXTURE_BORDER_COLOR, borderColor);
 #endif
  
     GET_GL_ERROR;
  
     if (target == GL_TEXTURE_2D)
     {
         glTexImage2D(GL_TEXTURE_2D,
                      0,
                      GL_DEPTH_COMPONENT32F,
                      _dimensions.x,
                      _dimensions.y,
                      0,
                      GL_DEPTH_COMPONENT,
                      GL_FLOAT,
                      nullptr);
         GET_GL_ERROR;
  
         // Attach texture to framebuffer.
         glFramebufferTexture2D(GL_FRAMEBUFFER,
                                GL_DEPTH_ATTACHMENT,
                                GL_TEXTURE_2D,
                                _texID,
                                0);
         GET_GL_ERROR;
     }
     else // target is GL_TEXTURE_CUBE_MAP
     {
         for (SLint i = 0; i < 6; ++i)
         {
             glTexImage2D(GL_TEXTURE_CUBE_MAP_POSITIVE_X + i,
                          0,
                          GL_DEPTH_COMPONENT32F,
                          _dimensions.x,
                          _dimensions.y,
                          0,
                          GL_DEPTH_COMPONENT,
                          GL_FLOAT,
                          nullptr);
             GET_GL_ERROR;
  
             // Attach texture to framebuffer.
             glFramebufferTexture2D(GL_FRAMEBUFFER,
                                    GL_DEPTH_ATTACHMENT,
                                    GL_TEXTURE_CUBE_MAP_POSITIVE_X + i,
                                    _texID,
                                    0);
             GET_GL_ERROR;
         }
     }
  
 #ifndef SL_GLES
     glDrawBuffer(GL_NONE);
     GET_GL_ERROR;
 #endif
  
     glReadBuffer(GL_NONE);
     GET_GL_ERROR;
  
     unbind();
  
     if (glCheckFramebufferStatus(GL_FRAMEBUFFER) != GL_FRAMEBUFFER_COMPLETE)
         SL_LOG("FBO failed to initialize correctly.");
     GET_GL_ERROR;
 }

◆ ~SLGLDepthBuffer()

SLGLDepthBuffer::~SLGLDepthBuffer ( )

Definition at line 127 of file SLGLDepthBuffer.cpp.

 {
     glDeleteTextures(1, &_texID);
     GET_GL_ERROR;
  
     glDeleteFramebuffers(1, &_fboID);
     GET_GL_ERROR;
 }

Member Function Documentation

◆ bind()

void SLGLDepthBuffer::bind ( )

Binds the OpenGL frame buffer object for the depth buffer.

Definition at line 168 of file SLGLDepthBuffer.cpp.

 {
     // Keep the previous FB ID for later unbinding
     glGetIntegerv(GL_FRAMEBUFFER_BINDING, &_prevFboID);
     glBindFramebuffer(GL_FRAMEBUFFER, _fboID);
     GET_GL_ERROR;
 }

◆ bindActive()

void SLGLDepthBuffer::bindActive ( SLuint texUnit ) const

Sets the active texture unit within the shader and binds the texture.

The uniform location loc must be requested before with glUniformLocation. The texture unit value must correspond to the number that is set with glUniform1i(loc, texUnit).

Parameters

texUnit Texture Unit value

Definition at line 143 of file SLGLDepthBuffer.cpp.

 {
  
     SLGLState* stateGL = SLGLState::instance();
     stateGL->activeTexture(GL_TEXTURE0 + texUnit);
     stateGL->bindTexture(_target, _texID);
 }

◆ bindFace()

void SLGLDepthBuffer::bindFace ( SLenum face ) const

Binds a specific texture face of a cube map depth buffer.

Definition at line 187 of file SLGLDepthBuffer.cpp.

 {
     assert(_target == GL_TEXTURE_CUBE_MAP);
     assert(face >= GL_TEXTURE_CUBE_MAP_POSITIVE_X &&
            face <= GL_TEXTURE_CUBE_MAP_NEGATIVE_Z);
  
     glFramebufferTexture2D(GL_FRAMEBUFFER,
                            GL_DEPTH_ATTACHMENT,
                            face,
                            _texID,
                            0);
     GET_GL_ERROR;
 }

◆ dimensions()

SLVec2i SLGLDepthBuffer::dimensions ( )

inline

Definition at line 38 of file SLGLDepthBuffer.h.

38 { return _dimensions; }

◆ readPixels()

SLfloat * SLGLDepthBuffer::readPixels ( ) const

Definition at line 152 of file SLGLDepthBuffer.cpp.

 {
     SLfloat* depth = new SLfloat[_dimensions.y * _dimensions.x];
     glReadPixels(0,
                  0,
                  _dimensions.x,
                  _dimensions.y,
                  GL_DEPTH_COMPONENT,
                  GL_FLOAT,
                  depth);
     GET_GL_ERROR;
     return depth;
 }

◆ target()

SLint SLGLDepthBuffer::target ( )

inline

Definition at line 32 of file SLGLDepthBuffer.h.

32 { return _target; }

◆ texID()

SLint SLGLDepthBuffer::texID ( )

inline

Definition at line 31 of file SLGLDepthBuffer.h.

31 { return _texID; }

◆ unbind()

void SLGLDepthBuffer::unbind ( )

Ends the usage of the depth buffer frame buffer.

Definition at line 178 of file SLGLDepthBuffer.cpp.

 {
     // iOS does not allow binding to 0. That's why we keep the previous FB ID
     glBindFramebuffer(GL_FRAMEBUFFER, _prevFboID);
     GET_GL_ERROR;
 }

Member Data Documentation

◆ _dimensions

SLVec2i SLGLDepthBuffer::_dimensions

private

Size of the texture.

Definition at line 41 of file SLGLDepthBuffer.h.

◆ _fboID

SLuint SLGLDepthBuffer::_fboID

private

ID of the FB object.

Definition at line 42 of file SLGLDepthBuffer.h.

◆ _prevFboID

SLint SLGLDepthBuffer::_prevFboID

private

ID of the previously bound FB.

Definition at line 43 of file SLGLDepthBuffer.h.

◆ _target

SLenum SLGLDepthBuffer::_target

private

GL_TEXTURE_2D or GL_TEXTURE_CUBE_MAP.

Definition at line 45 of file SLGLDepthBuffer.h.

◆ _texID

SLuint SLGLDepthBuffer::_texID

private

ID of the texture.

Definition at line 44 of file SLGLDepthBuffer.h.

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SLGLDepthBuffer()

◆ ~SLGLDepthBuffer()

Member Function Documentation

◆ bind()

◆ bindActive()

◆ bindFace()

◆ dimensions()

◆ readPixels()

◆ target()

◆ texID()

◆ unbind()

Member Data Documentation

◆ _dimensions

◆ _fboID

◆ _prevFboID

◆ _target

◆ _texID