Open 3D Engine TextureAtlas Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
TextureAtlasNamespace::TextureAtlas Class Referenceabstract

An abstract class that exposes atlas pointers to the rest of the codebase. More...

#include <TextureAtlas.h>

Inherited by TextureAtlasNamespace::TextureAtlasImpl.

Public Member Functions

 AZ_CLASS_ALLOCATOR (TextureAtlas, AZ::SystemAllocator)
 
 AZ_TYPE_INFO (TextureAtlas, "{56FF34CF-7C5B-4BBC-9E2B-AFCA1C6C7561}")
 
virtual AtlasCoordinates GetAtlasCoordinates (const AZStd::string &handle) const =0
 Retrieve a coordinate set from the Atlas by its handle.
 
virtual void SetTexture (AZ::Data::Instance< AZ::RPI::Image > image)=0
 Links this atlas to an image pointer.
 
virtual AZ::Data::Instance< AZ::RPI::Image > GetTexture () const =0
 Returns the image linked to this atlas.
 
virtual int GetWidth () const =0
 Returns the width of the atlas.
 
virtual int GetHeight () const =0
 Returns the height of the atlas.
 

Detailed Description

An abstract class that exposes atlas pointers to the rest of the codebase.

Member Function Documentation

◆ GetAtlasCoordinates()

virtual AtlasCoordinates TextureAtlasNamespace::TextureAtlas::GetAtlasCoordinates ( const AZStd::string &  handle) const
pure virtual

Retrieve a coordinate set from the Atlas by its handle.

Implemented in TextureAtlasNamespace::TextureAtlasImpl.

◆ GetHeight()

virtual int TextureAtlasNamespace::TextureAtlas::GetHeight ( ) const
pure virtual

Returns the height of the atlas.

Implemented in TextureAtlasNamespace::TextureAtlasImpl.

◆ GetTexture()

virtual AZ::Data::Instance< AZ::RPI::Image > TextureAtlasNamespace::TextureAtlas::GetTexture ( ) const
pure virtual

Returns the image linked to this atlas.

Implemented in TextureAtlasNamespace::TextureAtlasImpl.

◆ GetWidth()

virtual int TextureAtlasNamespace::TextureAtlas::GetWidth ( ) const
pure virtual

Returns the width of the atlas.

Implemented in TextureAtlasNamespace::TextureAtlasImpl.

◆ SetTexture()

virtual void TextureAtlasNamespace::TextureAtlas::SetTexture ( AZ::Data::Instance< AZ::RPI::Image >  image)
pure virtual

Links this atlas to an image pointer.

Implemented in TextureAtlasNamespace::TextureAtlasImpl.

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