This class is the base class for all 2D textures receiving their image content from Media objects. More...

#include <MediaTexture2D.h>

Inheritance diagram for Ocean::Rendering::MediaTexture2D:

Public Member Functions
virtual Media::FrameMediumRef	medium () const
	Returns the frame medium of this texture.

virtual void	setMedium (const Media::FrameMediumRef &medium)
	Sets the frame medium of this texture.

FrameType	frameType () const override
	Returns the frame type of this texture.

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

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

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.

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

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

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

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

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

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.

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

ObjectRefs	parentObjects () const
	Returns all parent objects.

ObjectRefSet	parentNodes () const
	Returns all parent nodes.

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

Protected Member Functions
	MediaTexture2D ()
	Creates a new 2D media texture object.

	~MediaTexture2D () override
	Destructs a 2D media texture object.

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

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

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

	~Texture () override
	Destructs a texture object.

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

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

virtual	~Object ()
	Destructs an object.

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

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

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

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

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

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

Protected Attributes
Media::FrameMediumRef	frameMedium_
	Frame medium providing the image data.

FrameType	frameType_
	The frame type of the current frame.

Timestamp	frameTimestamp_
	The timestamp of the current frame.

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

Additional Inherited Members
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...

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

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

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.

Detailed Description

This class is the base class for all 2D textures receiving their image content from Media objects.

See also: FrameTexture2D.

Constructor & Destructor Documentation

◆ MediaTexture2D()

Ocean::Rendering::MediaTexture2D::MediaTexture2D ( )

protected

Creates a new 2D media texture object.

◆ ~MediaTexture2D()

Ocean::Rendering::MediaTexture2D::~MediaTexture2D ( )

overrideprotected

Destructs a 2D media texture object.

Member Function Documentation

◆ frameType()

FrameType Ocean::Rendering::MediaTexture2D::frameType ( ) const

overridevirtual

Returns the frame type of this texture.

Returns: Texture frame type

Reimplemented from Ocean::Rendering::Texture2D.

◆ hasTransparentPixel()

bool Ocean::Rendering::MediaTexture2D::hasTransparentPixel ( ) const

overridevirtual

Returns whether this texture contains at least one transparent pixel.

Returns: True, if so

Reimplemented from Ocean::Rendering::Texture2D.

◆ medium()

virtual Media::FrameMediumRef Ocean::Rendering::MediaTexture2D::medium ( ) const

virtual

Returns the frame medium of this texture.

Exceptions

NotSupportedException Is thrown if this function is not supported

Returns: Frame medium providing the image data

See also: setMedium(), Media::FrameMedium.

◆ setMedium()

virtual void Ocean::Rendering::MediaTexture2D::setMedium ( const Media::FrameMediumRef & medium )

virtual

Sets the frame medium of this texture.

Exceptions

NotSupportedException Is thrown if this function is not supported

Parameters

medium Frame medium to set

See also: medium(), Media::FrameMedium.

◆ type()

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

overridevirtual

Returns the type of this object.

See also: Object::type().

Reimplemented from Ocean::Rendering::Object.

Field Documentation

◆ frameMedium_

Media::FrameMediumRef Ocean::Rendering::MediaTexture2D::frameMedium_

protected

Frame medium providing the image data.

◆ frameTimestamp_

Timestamp Ocean::Rendering::MediaTexture2D::frameTimestamp_

protected

The timestamp of the current frame.

◆ frameType_

FrameType Ocean::Rendering::MediaTexture2D::frameType_

protected

The frame type of the current frame.

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

MediaTexture2D.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MediaTexture2D()

◆ ~MediaTexture2D()

Member Function Documentation

◆ frameType()

◆ hasTransparentPixel()

◆ medium()

◆ setMedium()

◆ type()

Field Documentation

◆ frameMedium_

◆ frameTimestamp_

◆ frameType_