CeresEngine::StreamingTexture Class Reference

A texture type that is backed by streamable mip and layer data. More...

#include <CeresEngine/Texture/Texture.hpp>

Inheritance diagram for CeresEngine::StreamingTexture:

Classes
struct	LayerData
	Data per-layer of the texture. More...
struct	MipData
	A mip-level bitmap data for a texture. More...

Public Member Functions
	StreamingTexture (ResourceData &resourceData, TExtent3< UInt32 > extent, Format format=Format::RGBA8UNorm)
	Creates a new empty StreamingTexture.
	StreamingTexture (ResourceData &resourceData, const Bitmap &bitmap)
	Creates a new StreamingTexture from an existing bitmap.
	StreamingTexture (ResourceData &resourceData, const Texture &other)
	Creates a new StreamingTexture by copying from another.
Async< Bitmap >	getBitmap (UInt32 layer=0, UInt32 mip=0) const override
	Gets a bitmap pixel data for the given layer and mip level.
Async	setBitmap (const Bitmap &bitmap, UInt32 layer=0, UInt32 mip=0) override
	Sets a new bitmap pixel data for the given layer and mip level.
Async< TexturePixelStream >	getPixelStream (UInt32 layer=0, UInt32 mip=0) const
	Gets a pixel stream for the given layer and mip level.
Public Member Functions inherited from CeresEngine::TResource< StreamingTexture, Texture >
ResourceHandle< StreamingTexture >	getResourceHandle () const noexcept
	Generates a hash for the provided type.
SPtr< StreamingTexture >	getShared () noexcept
	Gets a shared pointer to the resource.
SPtr< const StreamingTexture >	getShared () const noexcept
	Gets a shared pointer to the resource.
const ResourceTypeInfo &	getResourceType () const noexcept override
	Returns the resource type information descriptor.
	TResource (ResourceData &data, InputStream &dataStream)
void	serialize (OutputStream &dataStream) const override
	Serializes a resource by writing data to dataStream.
Public Member Functions inherited from CeresEngine::Texture
	Texture (const TextureProperties &properties)
	Creates a new texture.
	Texture (ResourceData &resourceData, const TextureProperties &properties)
	Creates a new texture.
	~Texture () noexcept override
	Destroys the texture object.
bool	isStreaming () const noexcept
	Determines if the texture is a streaming texture.
const TextureProperties &	getProperties () const noexcept
	A structure that describes properties of an texture.
const TExtent3< UInt32 > &	getExtent () const noexcept
	Texture extent.
Format	getFormat () const noexcept
	Hardware texture format. By default Format::RGBA8UNorm.
Public Member Functions inherited from CeresEngine::TResource< Texture >
ResourceHandle< Texture >	getResourceHandle () const noexcept
	Generates a hash for the provided type.
SPtr< Texture >	getShared () noexcept
	Gets a shared pointer to the resource.
SPtr< const Texture >	getShared () const noexcept
	Gets a shared pointer to the resource.
const ResourceTypeInfo &	getResourceType () const noexcept override
	Returns the resource type information descriptor.
	TResource (ResourceData &data, InputStream &dataStream)
void	serialize (OutputStream &dataStream) const override
	Serializes a resource by writing data to dataStream.
Public Member Functions inherited from CeresEngine::Resource
	Resource ()
	Default constructor for the Resource class.
	Resource (ResourceData &data)
	Creates a new Resource instance by passing a ResourceData instance.
virtual	~Resource () noexcept=default
	Resource virtual destructor.
ResourceManager *	getResourceManager () const noexcept
HResource	getResourceHandle () const noexcept
	Generates a hash for the provided type.
UUID	getResourceID () const noexcept
HResource	getParentResource () const noexcept
	A parent resource to which this resource is attached to.
SPtr< ResourceMetadata >	getResourceMetadata () const noexcept
	A pointer to the user-defined resource metadata.
const PackagePtr &	getPackage () const noexcept
	The package from which the resource was loaded from.
template<typename T = Resource>
SPtr< T >	getShared () noexcept
	Gets a shared pointer to the resource.
template<typename T = Resource>
SPtr< const T >	getShared () const noexcept
	Gets a shared pointer to the resource.
	Resource (ResourceData &data, InputStream &dataStream)
	Creates a new resource by reading data from dataStream.
Public Member Functions inherited from CeresEngine::IReflectable
virtual	~IReflectable () noexcept=default

Private Types
using	super = TResource< StreamingTexture, Texture >

Private Attributes
Vector< LayerData >	mLayers
	A vector of per-layer data.

Friends
class	TUserTypeInfo< StreamingTexture >

Additional Inherited Members
Static Public Member Functions inherited from CeresEngine::Resource
template<typename Processor >
static constexpr void	reflect (Processor &&RTTI)
	Executes the given processor for every field of the struct.
Protected Member Functions inherited from CeresEngine::Resource
HResourceStream	createStream (const ResourceStreamFlags &flags=ResourceStreamFlag::Default)
	Creates a new resource stream.
void	destroyStream (HResourceStream &stream)
	Destroys a stream.
void	markAsDirty ()
	Marks the resource as dirty.
Protected Attributes inherited from CeresEngine::Texture
TextureProperties	mProperties
	A structure that describes properties of an texture.

Detailed Description

A texture type that is backed by streamable mip and layer data.

Member Typedef Documentation

super

using CeresEngine::StreamingTexture::super = TResource<StreamingTexture, Texture>

private

Constructor & Destructor Documentation

StreamingTexture() [1/3]

CeresEngine::StreamingTexture::StreamingTexture ( ResourceData &  resourceData, TExtent3< UInt32 >  extent, Format  format = Format::RGBA8UNorm  )

explicit

Creates a new empty StreamingTexture.

Parameters

data	The texture data object to create the texture from.
extent	The texture extent.
format	The texture format.

StreamingTexture() [2/3]

CeresEngine::StreamingTexture::StreamingTexture ( ResourceData &  resourceData, const Bitmap &  bitmap  )

explicit

Creates a new StreamingTexture from an existing bitmap.

Parameters

data	The texture data object to create the texture from.
extent	The texture extent.
format	The texture format.

StreamingTexture() [3/3]

CeresEngine::StreamingTexture::StreamingTexture ( ResourceData &  resourceData, const Texture &  other  )

explicit

Creates a new StreamingTexture by copying from another.

This method can be used to transform any texture into a streaming texture.

Parameters

resourceData
other

Member Function Documentation

getBitmap()

Async< Bitmap > CeresEngine::StreamingTexture::getBitmap ( UInt32  layer = 0, UInt32  mip = 0  ) const

overridevirtual

Gets a bitmap pixel data for the given layer and mip level.

If either the layer (or mip level) are missing, a null pixel data is returned.

Implements CeresEngine::Texture.

getPixelStream()

Async< TexturePixelStream > CeresEngine::StreamingTexture::getPixelStream	(	UInt32	layer = 0,
		UInt32	mip = 0
	)		const

Gets a pixel stream for the given layer and mip level.

If either the layer (or mip level) are missing, an exception is thrown.

setBitmap()

Async CeresEngine::StreamingTexture::setBitmap ( const Bitmap &  bitmap, UInt32  layer = 0, UInt32  mip = 0  )

overridevirtual

Sets a new bitmap pixel data for the given layer and mip level.

Implements CeresEngine::Texture.

Friends And Related Symbol Documentation

TUserTypeInfo< StreamingTexture >

friend class TUserTypeInfo< StreamingTexture >

friend

Member Data Documentation

mLayers

Vector<LayerData> CeresEngine::StreamingTexture::mLayers

private

A vector of per-layer data.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Texture/Texture.hpp