Open 3D Engine Atom Gem API Reference 25.05.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ImageProcessingAtom::CImageObject Class Reference

Inherits ImageProcessingAtom::IImageObject.

Public Member Functions

 AZ_CLASS_ALLOCATOR (CImageObject, AZ::SystemAllocator)
 
 CImageObject (AZ::u32 width, AZ::u32 height, AZ::u32 maxMipCount, EPixelFormat pixelFormat)
 
 CImageObject (AZ::u32 width, AZ::u32 height, AZ::u32 depth, AZ::u32 maxMipCount, EPixelFormat pixelFormat)
 
IImageObjectAllocateImage (EPixelFormat pixelFormat, uint32_t maxMipCount=(std::numeric_limits< uint32_t >::max)()) const override
 
IImageObjectAllocateImage (uint32_t maxMipCount=(std::numeric_limits< uint32_t >::max)()) const override
 
IImageObjectClone (uint32_t maxMipCount=(std::numeric_limits< uint32_t >::max)()) const override
 
EPixelFormat GetPixelFormat () const override
 
AZ::u32 GetPixelCount (AZ::u32 mip) const override
 
AZ::u32 GetWidth (AZ::u32 mip) const override
 
AZ::u32 GetHeight (AZ::u32 mip) const override
 
AZ::u32 GetDepth (AZ::u32 mip) const override
 
AZ::u32 GetMipCount () const override
 
void GetImagePointer (AZ::u32 mip, AZ::u8 *&pMem, AZ::u32 &pitch) const override
 
AZ::u32 GetMipBufSize (AZ::u32 mip) const override
 
void SetMipData (AZ::u32 mip, AZ::u8 *mipBuf, AZ::u32 bufSize, AZ::u32 pitch) override
 
AZ::u32 GetImageFlags () const override
 
void SetImageFlags (AZ::u32 imageFlags) override
 
void AddImageFlags (AZ::u32 imageFlags) override
 
void RemoveImageFlags (AZ::u32 imageFlags) override
 
bool HasImageFlags (AZ::u32 imageFlags) const override
 
void ScaleAndBiasChannels (AZ::u32 firstMip, AZ::u32 maxMipCount, const AZ::Vector4 &scale, const AZ::Vector4 &bias) override
 
void ClampChannels (AZ::u32 firstMip, AZ::u32 maxMipCount, const AZ::Vector4 &min, const AZ::Vector4 &max) override
 
void TransferAlphaCoverage (const TextureSettings *textureSetting, const IImageObjectPtr srcImg) override
 
float ComputeAlphaCoverageScaleFactor (AZ::u32 mip, float fDesiredCoverage, float fAlphaRef) const override
 
float ComputeAlphaCoverage (AZ::u32 firstMip, float fAlphaRef) const override
 
bool CompareImage (const IImageObjectPtr otherImage) const override
 
uint32_t GetTextureMemory () const override
 
EAlphaContent GetAlphaContent () const override
 
void NormalizeVectors (AZ::u32 firstMip, AZ::u32 maxMipCount) override
 
void CopyPropertiesFrom (const IImageObjectPtr src) override
 
void Swizzle (const char channels[4]) override
 
void GetColorRange (AZ::Color &minColor, AZ::Color &maxColor) const override
 
void SetColorRange (const AZ::Color &minColor, const AZ::Color &maxColor) override
 
float GetAverageBrightness () const override
 
void SetAverageBrightness (float avgBrightness) override
 
AZ::Color GetAverageColor () const override
 
void SetAverageColor (const AZ::Color &averageColor) override
 
AZ::u32 GetNumPersistentMips () const override
 
void SetNumPersistentMips (AZ::u32 nMips) override
 
void GlossFromNormals (bool hasAuthoredGloss) override
 
void ClearColor (float r, float g, float b, float a) override
 
void ResetImage (AZ::u32 width, AZ::u32 height, AZ::u32 maxMipCount, EPixelFormat pixelFormat)
 
void ResetImage (AZ::u32 width, AZ::u32 height, AZ::u32 depth, AZ::u32 maxMipCount, EPixelFormat pixelFormat)
 
void GetExtent (AZ::u32 &width, AZ::u32 &height, AZ::u32 &mipCount) const
 
void GetExtent (AZ::u32 &width, AZ::u32 &height, AZ::u32 &depth, AZ::u32 &mipCount) const
 
AZ::u32 GetMipDataSize (AZ::u32 mip) const
 
float CalculateAverageBrightness () const
 calculates the average brightness for a texture
 
bool HasPowerOfTwoSizes () const
 
void CopyPropertiesFrom (const CImageObject *src)
 
void NormalizeImageRange (EColorNormalization eColorNorm, EAlphaNormalization eAlphaNorm, bool bMaintainBlack=false, int nExponentBits=0)
 
void ExpandImageRange (EColorNormalization eColorNorm, EAlphaNormalization eAlphaNorm, int nExponentBits=0)
 

Additional Inherited Members

- Static Public Member Functions inherited from ImageProcessingAtom::IImageObject
static IImageObjectCreateImage (AZ::u32 width, AZ::u32 height, AZ::u32 maxMipCount, EPixelFormat pixelFormat)
 
static IImageObjectCreateImage (AZ::u32 width, AZ::u32 height, AZ::u32 depth, AZ::u32 maxMipCount, EPixelFormat pixelFormat)
 

Member Function Documentation

◆ AddImageFlags()

void ImageProcessingAtom::CImageObject::AddImageFlags ( AZ::u32  imageFlags)
overridevirtual

◆ AllocateImage() [1/2]

IImageObject * ImageProcessingAtom::CImageObject::AllocateImage ( EPixelFormat  pixelFormat,
uint32_t  maxMipCount = (std::numeric_limits< uint32_t >::max)() 
) const
overridevirtual

◆ AllocateImage() [2/2]

IImageObject * ImageProcessingAtom::CImageObject::AllocateImage ( uint32_t  maxMipCount = (std::numeric_limits< uint32_t >::max)()) const
overridevirtual

◆ ClampChannels()

void ImageProcessingAtom::CImageObject::ClampChannels ( AZ::u32  firstMip,
AZ::u32  maxMipCount,
const AZ::Vector4 &  min,
const AZ::Vector4 &  max 
)
overridevirtual

◆ ClearColor()

void ImageProcessingAtom::CImageObject::ClearColor ( float  r,
float  g,
float  b,
float  a 
)
overridevirtual

◆ Clone()

IImageObject * ImageProcessingAtom::CImageObject::Clone ( uint32_t  maxMipCount = (std::numeric_limits< uint32_t >::max)()) const
overridevirtual

◆ CompareImage()

bool ImageProcessingAtom::CImageObject::CompareImage ( const IImageObjectPtr  otherImage) const
overridevirtual

◆ ComputeAlphaCoverage()

float ImageProcessingAtom::CImageObject::ComputeAlphaCoverage ( AZ::u32  firstMip,
float  fAlphaRef 
) const
overridevirtual

◆ ComputeAlphaCoverageScaleFactor()

float ImageProcessingAtom::CImageObject::ComputeAlphaCoverageScaleFactor ( AZ::u32  mip,
float  fDesiredCoverage,
float  fAlphaRef 
) const
overridevirtual

◆ CopyPropertiesFrom()

void ImageProcessingAtom::CImageObject::CopyPropertiesFrom ( const IImageObjectPtr  src)
overridevirtual

◆ GetAlphaContent()

EAlphaContent ImageProcessingAtom::CImageObject::GetAlphaContent ( ) const
overridevirtual

◆ GetAverageBrightness()

float ImageProcessingAtom::CImageObject::GetAverageBrightness ( ) const
overridevirtual

◆ GetAverageColor()

AZ::Color ImageProcessingAtom::CImageObject::GetAverageColor ( ) const
overridevirtual

◆ GetColorRange()

void ImageProcessingAtom::CImageObject::GetColorRange ( AZ::Color &  minColor,
AZ::Color &  maxColor 
) const
overridevirtual

◆ GetDepth()

AZ::u32 ImageProcessingAtom::CImageObject::GetDepth ( AZ::u32  mip) const
overridevirtual

Reimplemented from ImageProcessingAtom::IImageObject.

◆ GetHeight()

AZ::u32 ImageProcessingAtom::CImageObject::GetHeight ( AZ::u32  mip) const
overridevirtual

◆ GetImageFlags()

AZ::u32 ImageProcessingAtom::CImageObject::GetImageFlags ( ) const
overridevirtual

◆ GetImagePointer()

void ImageProcessingAtom::CImageObject::GetImagePointer ( AZ::u32  mip,
AZ::u8 *&  pMem,
AZ::u32 &  pitch 
) const
overridevirtual

◆ GetMipBufSize()

AZ::u32 ImageProcessingAtom::CImageObject::GetMipBufSize ( AZ::u32  mip) const
overridevirtual

◆ GetMipCount()

AZ::u32 ImageProcessingAtom::CImageObject::GetMipCount ( ) const
overridevirtual

◆ GetNumPersistentMips()

AZ::u32 ImageProcessingAtom::CImageObject::GetNumPersistentMips ( ) const
overridevirtual

◆ GetPixelCount()

AZ::u32 ImageProcessingAtom::CImageObject::GetPixelCount ( AZ::u32  mip) const
overridevirtual

◆ GetPixelFormat()

EPixelFormat ImageProcessingAtom::CImageObject::GetPixelFormat ( ) const
overridevirtual

◆ GetTextureMemory()

uint32_t ImageProcessingAtom::CImageObject::GetTextureMemory ( ) const
overridevirtual

◆ GetWidth()

AZ::u32 ImageProcessingAtom::CImageObject::GetWidth ( AZ::u32  mip) const
overridevirtual

◆ GlossFromNormals()

void ImageProcessingAtom::CImageObject::GlossFromNormals ( bool  hasAuthoredGloss)
overridevirtual

◆ HasImageFlags()

bool ImageProcessingAtom::CImageObject::HasImageFlags ( AZ::u32  imageFlags) const
overridevirtual

◆ NormalizeVectors()

void ImageProcessingAtom::CImageObject::NormalizeVectors ( AZ::u32  firstMip,
AZ::u32  maxMipCount 
)
overridevirtual

◆ RemoveImageFlags()

void ImageProcessingAtom::CImageObject::RemoveImageFlags ( AZ::u32  imageFlags)
overridevirtual

◆ ScaleAndBiasChannels()

void ImageProcessingAtom::CImageObject::ScaleAndBiasChannels ( AZ::u32  firstMip,
AZ::u32  maxMipCount,
const AZ::Vector4 &  scale,
const AZ::Vector4 &  bias 
)
overridevirtual

◆ SetAverageBrightness()

void ImageProcessingAtom::CImageObject::SetAverageBrightness ( float  avgBrightness)
overridevirtual

◆ SetAverageColor()

void ImageProcessingAtom::CImageObject::SetAverageColor ( const AZ::Color &  averageColor)
overridevirtual

◆ SetColorRange()

void ImageProcessingAtom::CImageObject::SetColorRange ( const AZ::Color &  minColor,
const AZ::Color &  maxColor 
)
overridevirtual

◆ SetImageFlags()

void ImageProcessingAtom::CImageObject::SetImageFlags ( AZ::u32  imageFlags)
overridevirtual

◆ SetMipData()

void ImageProcessingAtom::CImageObject::SetMipData ( AZ::u32  mip,
AZ::u8 *  mipBuf,
AZ::u32  bufSize,
AZ::u32  pitch 
)
overridevirtual

◆ SetNumPersistentMips()

void ImageProcessingAtom::CImageObject::SetNumPersistentMips ( AZ::u32  nMips)
overridevirtual

◆ Swizzle()

void ImageProcessingAtom::CImageObject::Swizzle ( const char  channels[4])
overridevirtual

◆ TransferAlphaCoverage()

void ImageProcessingAtom::CImageObject::TransferAlphaCoverage ( const TextureSettings textureSetting,
const IImageObjectPtr  srcImg 
)
overridevirtual

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