A texture that is backed by a GPU image. These textures usually can't be serialized. More...

#include <CeresEngine/Texture/Texture.hpp>

Inheritance diagram for CeresEngine::GPUTexture:

Public Member Functions
	GPUTexture (const GPUImagePtr &image)
	Creates a new GPU texture from an existing GPU image.

const GPUImagePtr &	getImage () const noexcept
	A pointer to the GPU image object.

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.

Public Member Functions inherited from CeresEngine::TResource< GPUTexture, Texture >
ResourceHandle< GPUTexture >	getResourceHandle () const noexcept
	Generates a hash for the provided type.

SPtr< GPUTexture >	getShared () noexcept
	Gets a shared pointer to the resource.

SPtr< const GPUTexture >	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< GPUTexture, Texture >

Private Attributes
GPUImagePtr	mImage
	A pointer to the GPU image object.

Friends
class	TUserTypeInfo< GPUTexture >

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 that is backed by a GPU image. These textures usually can't be serialized.

Member Typedef Documentation

◆ super

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

private

Constructor & Destructor Documentation

◆ GPUTexture()

CeresEngine::GPUTexture::GPUTexture ( const GPUImagePtr & image )

explicit

Creates a new GPU texture from an existing GPU image.

Parameters

image The existing GPU image to create a new GPU texture from.

Member Function Documentation

◆ getBitmap()

Async< Bitmap > CeresEngine::GPUTexture::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.

◆ getImage()

const GPUImagePtr & CeresEngine::GPUTexture::getImage ( ) const

inlinenoexcept

A pointer to the GPU image object.

◆ setBitmap()

Async CeresEngine::GPUTexture::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< GPUTexture >

friend class TUserTypeInfo< GPUTexture >

friend

Member Data Documentation

◆ mImage

GPUImagePtr CeresEngine::GPUTexture::mImage