This class is the base class for all 2D textures receiving their image content from a frame or a buffer. More...

Inheritance diagram for Ocean::Rendering::FrameTexture2D:

Data Structures
class	CompressedFrame
	This class implements a container for a compressed texture. More...

Public Types
enum	CompressedFormat : uint32_t { CF_INVALID = 0u , CF_RGBA_ASTC_4X4 , CF_RGBA_ASTC_6X6 , CF_RGBA_ASTC_8X8 , CF_SRGBA_ASTC_4X4 , CF_SRGBA_ASTC_6X6 , CF_SRGBA_ASTC_8X8 }
	Definition of individual compressed texture formats. More...

typedef std::vector< uint8_t >	Buffer
	Definition of a vector holding bytes. More...

Public Types inherited from Ocean::Rendering::Texture
enum	EnvironmentMode { MODE_INVALID , MODE_ADD , MODE_ADD_SIGNED , MODE_BLEND , MODE_MODULATE , MODE_REPLACE , MODE_SUBTRACT }
	Definition of possible texture environment modes. More...

enum	MinFilterMode { MIN_MODE_INVALID , MIN_MODE_LINEAR , MIN_MODE_NEAREST , MIN_MODE_NEAREST_MIPMAP_NEAREST , MIN_MODE_LINEAR_MIPMAP_NEAREST , MIN_MODE_NEAREST_MIPMAP_LINEAR , MIN_MODE_LINEAR_MIPMAP_LINEAR }
	Definition of possible minification filter modes. More...

enum	MagFilterMode { MAG_MODE_INVALID , MAG_MODE_LINEAR , MAG_MODE_NEAREST }
	Definition of possible magnification filter modes. More...

enum	WrapType { WRAP_INVALID , WRAP_CLAMP , WRAP_REPEAT }
	Definition of different texture wrapping types. More...

Public Types inherited from Ocean::Rendering::Object
enum	ObjectType { TYPE_UNKNOWN , TYPE_ABSOLUTE_TRANSFORM , TYPE_ATTRIBUTE , TYPE_ATTRIBUTE_SET , TYPE_BACKGROUND , TYPE_BILLBOARD , TYPE_BITMAP_FRAMEBUFFER , TYPE_BLEND_ATTRIBUTE , TYPE_BOX , TYPE_CONE , TYPE_CYLINDER , TYPE_DEPTH_ATTRIBUTE , TYPE_DIRECTIONAL_LIGHT , TYPE_FRAMEBUFFER , TYPE_FRAME_TEXTURE_2D , TYPE_GEOMETRY , TYPE_GROUP , TYPE_INDEPENDENT_PRIMITIVE , TYPE_LIGHT_SOURCE , TYPE_LINES , TYPE_LINE_STRIPS , TYPE_LOD , TYPE_MATERIAL , TYPE_NODE , TYPE_OBJECT , TYPE_PARALLEL_VIEW , TYPE_PERSPECTIVE_VIEW , TYPE_PHANTOM_ATTRIBUTE , TYPE_POINT_LIGHT , TYPE_POINTS , TYPE_PRIMITIVE , TYPE_PRIMITIVE_ATTRIBUTE , TYPE_QUAD_STRIPS , TYPE_QUADS , TYPE_RENDERABLE , TYPE_SCENE , TYPE_SHADER_PROGRAM , TYPE_SHAPE , TYPE_SKY_BACKGROUND , TYPE_SPHERE , TYPE_SPOT_LIGHT , TYPE_STEREO_ATTRIBUTE , TYPE_STEREO_VIEW , TYPE_STRIP_PRIMITIVE , TYPE_SWITCH , TYPE_TEXT , TYPE_TEXTURE , TYPE_TEXTURE_2D , TYPE_MEDIA_TEXTURE_2D , TYPE_TEXTURE_FRAMEBUFFER , TYPE_TEXTURES , TYPE_TRANSFORM , TYPE_TRIANGLE_FANS , TYPE_TRIANGLES , TYPE_TRIANGLE_STRIPS , TYPE_UNDISTORTED_BACKGROUND , TYPE_VERTEX_SET , TYPE_VIEW , TYPE_WINDOW_FRAMEBUFFER }
	Definition of different object type. More...

typedef std::unordered_map< ObjectId, unsigned int >	ObjectIdMap
	Definition of a map holding object ids to reference counters. More...

Public Member Functions
virtual bool	setTexture (Frame &&frame)=0
	Sets or updates the texture with a given frame. More...

virtual bool	setTexture (CompressedFrame &&compressedFrame)=0
	Sets or updates the texture with a given compressed frame. More...

ObjectType	type () const override
	Returns the type of this object. More...

Public Member Functions inherited from Ocean::Rendering::Texture2D
virtual Vector2	imageTextureRatio () const
	Returns the ratio between original image dimension and actual texture dimension in horizontal and vertical dimensions. More...

virtual WrapType	wrapTypeS () const
	Returns the texture wrap type in s direction. More...

virtual WrapType	wrapTypeT () const
	Returns the texture wrap type in t direction. More...

virtual bool	setWrapTypeS (const WrapType type)
	Sets the texture wrap type in s direction. More...

virtual bool	setWrapTypeT (const WrapType type)
	Sets the texture wrap type in t direction. More...

virtual FrameType	frameType () const
	Returns the frame type of this 2D texture. More...

virtual bool	hasTransparentPixel () const
	Returns whether this texture contains at least one transparent pixel. More...

ObjectType	type () const override
	Returns the type of this object. More...

Public Member Functions inherited from Ocean::Rendering::Texture
virtual std::string	textureName () const =0
	Returns the name of the texture e.g., in a shader. More...

virtual HomogenousMatrix4	transformation () const
	Returns the texture transformation matrix. More...

virtual EnvironmentMode	environmentMode () const
	Returns the environment mode for this texture. More...

virtual MinFilterMode	minificationFilterMode () const
	Returns the minification filter mode for this texture. More...

virtual MagFilterMode	magnificationFilterMode () const
	Returns the magnification filter mode for this texture. More...

virtual bool	usingMipmaps () const
	Returns whether mipmaps are used. More...

virtual bool	adjustedToPowerOfTwo () const
	Returns whether the internal texture size has been extended to power-of-two dimensions to hand the reduced graphic power of the system. More...

virtual bool	setTextureName (const std::string &name)=0
	Sets the name of the texture e.g., in a shader. More...

virtual void	setTransformation (const HomogenousMatrix4 &transformation)
	Sets the texture transformation matrix. More...

virtual void	setEnvironmentMode (const EnvironmentMode mode)
	Sets the environment mode for this texture. More...

virtual void	setMinificationFilterMode (const MinFilterMode mode)
	Sets the minification filter mode for this texture. More...

virtual void	setMagnificationFilterMode (const MagFilterMode mode)
	Sets the magnification filter mode for this texture. More...

virtual void	setUseMipmaps (const bool flag)
	Specifies whether mipmaps will be used. More...

virtual bool	isValid () const
	Returns whether the texture internally holds valid data. More...

Public Member Functions inherited from Ocean::Rendering::Object
ObjectId	id () const
	Returns the unique object id of this object. More...

const std::string &	name () const
	Returns the name of this object. More...

virtual void	setName (const std::string &name)
	Sets or changes the name of this object. More...

virtual const std::string &	engineName () const =0
	Returns the name of the owner engine. More...

ObjectRefs	parentObjects () const
	Returns all parent objects. More...

ObjectRefSet	parentNodes () const
	Returns all parent nodes. More...

virtual std::string	descriptiveInformation () const
	Returns descriptive information about the object as string. More...

Protected Member Functions
	FrameTexture2D ()
	Creates a new 2D frame texture object. More...

	~FrameTexture2D () override
	Destructs a 2D frame texture object. More...

Protected Member Functions inherited from Ocean::Rendering::Texture2D
	Texture2D ()
	Creates a new 2D texture object. More...

	~Texture2D () override
	Destructs a 2D texture object. More...

Protected Member Functions inherited from Ocean::Rendering::Texture
	Texture ()
	Creates a new texture object. More...

	~Texture () override
	Destructs a texture object. More...

Protected Member Functions inherited from Ocean::Rendering::Object
	Object ()
	Creates a new object. More...

	Object (const Object &object)=delete
	Disabled copy constructor. More...

virtual	~Object ()
	Destructs an object. More...

Engine &	engine () const
	Returns the render engine which is owner of this object. More...

void	registerParent (const ObjectId parentId)
	Registers a parent node for this (child) node. More...

void	unregisterParent (const ObjectId parentId)
	Unregisters a parent node for this (child) node. More...

void	registerThisObjectAsParent (const ObjectRef &child)
	Registers this object at a child as parent object. More...

void	unregisterThisObjectAsParent (const ObjectRef &child)
	Unregisters this object from a child as parent. More...

Object &	operator= (const Object &object)=delete
	Disabled copy operator. More...

Additional Inherited Members
Static Public Member Functions inherited from Ocean::Rendering::Object
static std::string	translateObjectType (const ObjectType objectType)
	Translates an object type to a readable string. More...

Static Protected Member Functions inherited from Ocean::Rendering::Texture2D
static void	calculatePowerOfTwoDimension (const unsigned int width, const unsigned int height, unsigned int &powerOfTwoWidth, unsigned int &powerOfTwoHeight)
	Calculates the smallest power of two texture in which a given image with arbitrary dimension fits. More...

Protected Attributes inherited from Ocean::Rendering::Object
Lock	objectLock
	Lock for the object. More...

Detailed Description

This class is the base class for all 2D textures receiving their image content from a frame or a buffer.

See also: MediaTexture2D.

Member Typedef Documentation

◆ Buffer

typedef std::vector<uint8_t> Ocean::Rendering::FrameTexture2D::Buffer

Definition of a vector holding bytes.

Member Enumeration Documentation

◆ CompressedFormat

enum Ocean::Rendering::FrameTexture2D::CompressedFormat : uint32_t

Definition of individual compressed texture formats.

Enumerator
CF_INVALID	Invalid format.
CF_RGBA_ASTC_4X4	Compressed texture with format RGBA ASTC 4x4.
CF_RGBA_ASTC_6X6	Compressed texture with format RGBA ASTC 6x6.
CF_RGBA_ASTC_8X8	Compressed texture with format RGBA ASTC 8x8.
CF_SRGBA_ASTC_4X4	Compressed texture with format sRGBA ASTC 4x4.
CF_SRGBA_ASTC_6X6	Compressed texture with format sRGBA ASTC 6x6.
CF_SRGBA_ASTC_8X8	Compressed texture with format sRGBA ASTC 8x8.

Constructor & Destructor Documentation

◆ FrameTexture2D()

Ocean::Rendering::FrameTexture2D::FrameTexture2D ( )

protected

Creates a new 2D frame texture object.

◆ ~FrameTexture2D()

Ocean::Rendering::FrameTexture2D::~FrameTexture2D ( )

overrideprotected

Destructs a 2D frame texture object.

Member Function Documentation

◆ setTexture() [1/2]

virtual bool Ocean::Rendering::FrameTexture2D::setTexture ( CompressedFrame && compressedFrame )

pure virtual

Sets or updates the texture with a given compressed frame.

Parameters

compressedFrame The compressed frame containing the new texture information, must be valid

Returns: True, if succeeded

Implemented in Ocean::Rendering::GLESceneGraph::GLESFrameTexture2D.

◆ setTexture() [2/2]

virtual bool Ocean::Rendering::FrameTexture2D::setTexture ( Frame && frame )

pure virtual

Sets or updates the texture with a given frame.

Parameters

frame The frame containing the new texture information, must be valid

Returns: True, if succeeded

Implemented in Ocean::Rendering::GLESceneGraph::GLESFrameTexture2D.

◆ type()

ObjectType Ocean::Rendering::FrameTexture2D::type ( ) const

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Object.

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

FrameTexture2D.h

Data Structures

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members