Texture.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2010 - 2015 Leonid Kostrykin
 *
 *  Chair of Medical Engineering (mediTEC)
 *  RWTH Aachen University
 *  Pauwelsstr. 20
 *  52074 Aachen
 *  Germany
 *
 */

#ifndef TEXTURE_H_6014714286
#define TEXTURE_H_6014714286

#include <Carna/Carna.h>
#include <Carna/base/noncopyable.h>
#include <Carna/base/math.h>
#include <Carna/base/CarnaException.h>

namespace Carna
{

namespace base
{


// ----------------------------------------------------------------------------------
// bindGLTextureObject
// ----------------------------------------------------------------------------------

template< unsigned int dimension >
void bindGLTextureObject( unsigned int unit, unsigned int id )
{
    static_assert( dimension >= 1 && dimension <= 3, "Texture dimension must be 1, 2 or 3." );
}


template< >
void CARNA_LIB bindGLTextureObject< 1 >( unsigned int unit, unsigned int id );


template< >
void CARNA_LIB bindGLTextureObject< 2 >( unsigned int unit, unsigned int id );


template< >
void CARNA_LIB bindGLTextureObject< 3 >( unsigned int unit, unsigned int id );



// ----------------------------------------------------------------------------------
// TextureBase
// ----------------------------------------------------------------------------------

class CARNA_LIB TextureBase
{

    NON_COPYABLE

public:

    const unsigned int id;

    virtual ~TextureBase();

    const static unsigned int SETUP_UNIT = 0;
    
protected:

    TextureBase();

    void uploadGLTextureData
        ( const Eigen::Matrix< unsigned int, 1, 1 >& size
        , int internalFormat
        , int pixelFormat
        , int bufferType
        , const void* bufferPtr );
    
    void uploadGLTextureData
        ( const math::Vector2ui& size
        , int internalFormat
        , int pixelFormat
        , int bufferType
        , const void* bufferPtr );
    
    void uploadGLTextureData
        ( const math::Vector3ui& size
        , int internalFormat
        , int pixelFormat
        , int bufferType
        , const void* bufferPtr );
    
}; // TextureBase



// ----------------------------------------------------------------------------------
// Texture
// ----------------------------------------------------------------------------------

template< unsigned int dimension >
class Texture : public TextureBase
{

public:
    
    typedef Eigen::Matrix< unsigned int, dimension, 1 > Resolution;

    Texture( int internalFormat, int pixelFormat );
    
    const static unsigned int DIMENSION = dimension;

    const Resolution& size() const;
    
    bool isValid() const;
    
    const int internalFormat; 
    const int pixelFormat;    

    void bind( unsigned int unit ) const;
    
    void update( const Resolution& size, int bufferType, const void* bufferPtr );

    void update( const Resolution& size );
    
private:

    std::unique_ptr< Resolution > mySize;

}; // Texture


template< unsigned int dimension >
Texture< dimension >::Texture( int internalFormat, int pixelFormat )
    : internalFormat( internalFormat )
    , pixelFormat( pixelFormat )
{
    static_assert( dimension >= 1 && dimension <= 3, "Texture dimension must be 1, 2 or 3." );
    CARNA_ASSERT_EX( id != 0, "Texture acquisition failed!" );
}


template< unsigned int dimension >
void Texture< dimension >::bind( unsigned int unit ) const
{
    bindGLTextureObject< dimension >( unit, id );
}


template< unsigned int dimension >
bool Texture< dimension >::isValid() const
{
    return mySize.get() != nullptr;
}


template< unsigned int dimension >
const Eigen::Matrix< unsigned int, dimension, 1 >& Texture< dimension >::size() const
{
    CARNA_ASSERT( isValid() );
    return *mySize;
}


template< unsigned int dimension >
void Texture< dimension >::update( const Eigen::Matrix< unsigned int, dimension, 1 >& size, int bufferType, const void* bufferPtr )
{
    /* Ensure that texture size is positive.
     */
    for( unsigned int i = 0; i < dimension; ++i )
    {
        CARNA_ASSERT_EX( size( i, 0 ) >= 1, "Texture only supports positive sizes!" );
    }
    
    /* Ensure that z-component of the texture size is even if this is a 3D texture.
     */
    if( dimension == 3 )
    {
        CARNA_ASSERT_EX( size( 2, 0 ) % 2 == 0, "3D textures must have even depth!" );
    }
    
    /* Update the OpenGL texture object.
     */
    this->bind( SETUP_UNIT );
    uploadGLTextureData( size, internalFormat, pixelFormat, bufferType, bufferPtr );
}


template< unsigned int dimension >
void Texture< dimension >::update( const Eigen::Matrix< unsigned int, dimension, 1 >& size )
{
    update( size, 0, nullptr );
}



}  // namespace Carna :: base

}  // namespace Carna

#endif // TEXTURE_H_6014714286