Represents 3D OpenGL texture object whose lifetime is managed by instances of this class. More...

#include <ManagedTexture3D.h>

Inheritance diagram for Carna::base::ManagedTexture3D:

Collaboration diagram for Carna::base::ManagedTexture3D:

Public Types
typedef ManagedTexture3DInterface	ManagedInterface
	Defines the type to be used for interfacing the video resource.

Public Member Functions
virtual bool	controlsSameVideoResource (const GeometryFeature &) const override
	Tells whether this instance maintains the same video resources like other.

virtual ManagedTexture3DInterface *	acquireVideoResource () override
	Acquires the video resources from this `GeometryFeature` by returning new instance of a class derived from ManagedInterface, that realizes the RAII idiom. Refer to its documentation for details. May return `nullptr` if this `GeometryFeature` does not provide any video resources.

Public Member Functions inherited from Carna::base::GeometryFeature
unsigned int	videoResourceAcquisitionsCount () const
	Tells current number of video resource acquisitions.

void	release ()
	Denotes that this object is no longer required and may be deleted as soon as it is valid to delete it.

void	addTo (Geometry &sceneGraphNode, unsigned int role)
	Puts this geometry feature on the sceneGraphNode.

void	removeFrom (Geometry &sceneGraphNode)
	Removes this geometry feature from the sceneGraphNode.

Static Public Member Functions
static ManagedTexture3D &	create (const math::Vector3ui &size, int internalFormat, int pixelFormat, int bufferType, const void *bufferPtr)
	Instantiates. Invoke release when it isn't needed any longer.

Public Attributes
const math::Vector3ui	size
	Tells the resolution of this texture.

const int	internalFormat
	Holds the number of color components in the texture, e.g. `GL_RGBA8UI` or `GL_INTENSITY16`.

const int	pixelFormat
	Holds the format of the pixel data, e.g. `GL_RED`, `GL_RGB` or `GL_RGBA`.

const int	bufferType
	Specifies the data type of the pixel data to be uploaded to the texture.

const void *const	bufferPtr
	Points to the pixel data that will be uploaded to the texture.

const base::math::Matrix4f	textureCoordinatesCorrection
	Stretches texture coordinates s.t. the centers of the texels, that are located in the texture corners, become located in those corners.

Protected Member Functions
	ManagedTexture3D (const math::Vector3ui &size, int internalFormat, int pixelFormat, int bufferType, const void *bufferPtr)
	Instantiates.

	~ManagedTexture3D ()
	Deletes.

Protected Member Functions inherited from Carna::base::GeometryFeature
	GeometryFeature ()
	Instantiates.

virtual	~GeometryFeature ()
	Deletes and logs an error if video resources are leaked.

Protected Attributes
std::unique_ptr< Texture< 3 > >	textureObject
	Holds the maintained OpenGL texture object.

Friends
class	GeometryFeature

class	ManagedTexture3DInterface

Detailed Description

Represents 3D OpenGL texture object whose lifetime is managed by instances of this class.

Author: Leonid Kostrykin

Date: 22.2.15 - 24.3.15

Definition at line 44 of file ManagedTexture3D.h.

Member Typedef Documentation

◆ ManagedInterface

typedef ManagedTexture3DInterface Carna::base::ManagedTexture3D::ManagedInterface

Defines the type to be used for interfacing the video resource.

Definition at line 102 of file ManagedTexture3D.h.

Constructor & Destructor Documentation

◆ ManagedTexture3D()

Carna::base::ManagedTexture3D::ManagedTexture3D	(	const math::Vector3ui &	size,
		int	internalFormat,
		int	pixelFormat,
		int	bufferType,
		const void *	bufferPtr
	)

protected

Instantiates.

Parameters

size	is the resolution of this texture.
internalFormat	specifies the number of color components in the texture, e.g. `GL_RGBA8UI` or `GL_INTENSITY16`.
pixelFormat	specifies the format of the pixel data, e.g. `GL_RED`, `GL_RGB` or `GL_RGBA`.
bufferType	specifies the data type of the pixel data pointed to by bufferPtr.
bufferPtr	points to the pixel data that will be uploaded to the texture.

See also: Valid values for the parameters are available here: https://www.opengl.org/sdk/docs/man3/xhtml/glTexImage3D.xml

Attention: The instance does neither upload the pixel data from bufferPtr immediately, nor does it create a copy. Hence the pixel data located at bufferPtr must stay valid as long as an upload might be required.

Member Function Documentation

◆ acquireVideoResource()

virtual ManagedTexture3DInterface * Carna::base::ManagedTexture3D::acquireVideoResource ( )

overridevirtual

Acquires the video resources from this GeometryFeature by returning new instance of a class derived from ManagedInterface, that realizes the RAII idiom. Refer to its documentation for details. May return nullptr if this GeometryFeature does not provide any video resources.

Implements Carna::base::GeometryFeature.

◆ controlsSameVideoResource()

virtual bool Carna::base::ManagedTexture3D::controlsSameVideoResource ( const GeometryFeature & ) const

overridevirtual

Tells whether this instance maintains the same video resources like other.

This implementation always returns false.

Implements Carna::base::GeometryFeature.

Reimplemented in Carna::base::BufferedVectorFieldTexture< BufferedVectorFieldType >.

◆ create()

static ManagedTexture3D & Carna::base::ManagedTexture3D::create	(	const math::Vector3ui &	size,
		int	internalFormat,
		int	pixelFormat,
		int	bufferType,
		const void *	bufferPtr
	)

static

Instantiates. Invoke release when it isn't needed any longer.

Parameters

size	is the resolution of this texture.
internalFormat	specifies the number of color components in the texture, e.g. `GL_RGBA8UI` or `GL_INTENSITY16`.
pixelFormat	specifies the format of the pixel data, e.g. `GL_RED`, `GL_RGB` or `GL_RGBA`.
bufferType	specifies the data type of the pixel data pointed to by bufferPtr.
bufferPtr	points to the pixel data that will be uploaded to the texture.

See also: Valid values for the parameters are available here: https://www.opengl.org/sdk/docs/man3/xhtml/glTexImage3D.xml

Attention: The instance does neither upload the pixel data from bufferPtr immediately, nor does it create a copy. Hence the pixel data located at bufferPtr must stay valid as long as an upload might be required.

Friends And Related Symbol Documentation

◆ GeometryFeature

friend class GeometryFeature

friend

Definition at line 51 of file ManagedTexture3D.h.

◆ ManagedTexture3DInterface

friend class ManagedTexture3DInterface

friend

Definition at line 52 of file ManagedTexture3D.h.

Member Data Documentation

◆ bufferPtr

const void* const Carna::base::ManagedTexture3D::bufferPtr

Points to the pixel data that will be uploaded to the texture.

Definition at line 121 of file ManagedTexture3D.h.

◆ bufferType

const int Carna::base::ManagedTexture3D::bufferType

Specifies the data type of the pixel data to be uploaded to the texture.

Definition at line 120 of file ManagedTexture3D.h.

◆ internalFormat

const int Carna::base::ManagedTexture3D::internalFormat

Holds the number of color components in the texture, e.g. GL_RGBA8UI or GL_INTENSITY16.

Definition at line 118 of file ManagedTexture3D.h.

◆ pixelFormat

const int Carna::base::ManagedTexture3D::pixelFormat

Holds the format of the pixel data, e.g. GL_RED, GL_RGB or GL_RGBA.

Definition at line 119 of file ManagedTexture3D.h.

◆ size

const math::Vector3ui Carna::base::ManagedTexture3D::size

Tells the resolution of this texture.

Precondition: isValid() == true

Definition at line 117 of file ManagedTexture3D.h.

◆ textureCoordinatesCorrection

const base::math::Matrix4f Carna::base::ManagedTexture3D::textureCoordinatesCorrection

Stretches texture coordinates s.t. the centers of the texels, that are located in the texture corners, become located in those corners.

Consider a \(4 \times 4\) texture. Each texel occupies \(\frac{1}{4}\) along each axis, hence the texels' centers are located at \(\frac{1}{8}\), \(\frac{3}{8}\), \(\frac{5}{8}\) and \(\frac{7}{8}\) along those axis.

This matrix transforms texture coordinates s.t. \( 0 \mapsto \frac{1}{8}\) and \( 1 \mapsto \frac{7}{8}\) following the considerations from above.

Definition at line 135 of file ManagedTexture3D.h.

◆ textureObject

std::unique_ptr< Texture< 3 > > Carna::base::ManagedTexture3D::textureObject

protected

Holds the maintained OpenGL texture object.

Definition at line 93 of file ManagedTexture3D.h.

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

include/Carna/base/ManagedTexture3D.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends