######
IImage
######

.. cpp:namespace:: RED::IImage

.. default-domain:: cpp

Functions
=========

================================= ==============================================================================================================================================================================
:doc:`classRED_1_1CID`            :cpp:func:`GetClassID <static RED::CID RED::IImage::GetClassID()>`                                                                                                            
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetFormat <virtual RED_RC RED::IImage::GetFormat(RED::FORMAT &oFormat, int iStateNumber=-1) const =0>`                                                             
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetSize <virtual RED_RC RED::IImage::GetSize(int &oWidth, int &oHeight, int iStateNumber=-1) const =0>`                                                            
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetSize3D <virtual RED_RC RED::IImage::GetSize3D(int &oWidth, int &oHeight, int &oDepth, int iStateNumber=-1) const =0>`                                           
:cpp:enumerator:`~RED_RC`         :cpp:func:`IsPOTD <virtual RED_RC RED::IImage::IsPOTD(bool &oPOTD, int iStateNumber=-1) const =0>`                                                                            
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetSize <virtual RED_RC RED::IImage::SetSize(int iWidth, int iHeight, const RED::State &iState)=0>`                                                                
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetClosestPOTDSize <virtual RED_RC RED::IImage::SetClosestPOTDSize(const RED::State &iState)=0>`                                                                   
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetTarget <virtual RED_RC RED::IImage::GetTarget(TARGET &oTexTarget, int iStateNumber=-1) const =0>`                                                               
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetTarget <virtual RED_RC RED::IImage::SetTarget(RED::TARGET iTarget, const RED::State &iState)=0>`                                                                
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetMipmapMode <virtual RED_RC RED::IImage::GetMipmapMode(bool &oMipmapMode, int iStateNumber=-1) const =0>`                                                        
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetMipmapMode <virtual RED_RC RED::IImage::SetMipmapMode(bool iMipmapMode, const RED::State &iState)=0>`                                                           
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetIndirectMipmapMode <virtual RED_RC RED::IImage::GetIndirectMipmapMode(bool &oMipmapMode, int iStateNumber=-1) const =0>`                                        
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetIndirectMipmapMode <virtual RED_RC RED::IImage::SetIndirectMipmapMode(bool iMipmapMode, const RED::State &iState)=0>`                                           
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetWrapModes <virtual RED_RC RED::IImage::GetWrapModes(WRAP_MODE &oWrapU, WRAP_MODE &oWrapV, int iStateNumber=-1) const =0>`                                       
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetWrapModes <virtual RED_RC RED::IImage::SetWrapModes(WRAP_MODE iWrapU, WRAP_MODE iWrapV, const RED::State &iState)=0>`                                           
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetFilterModes <virtual RED_RC RED::IImage::GetFilterModes(FILTER_MODE &oMinFilter, FILTER_MODE &oMagFilter, int iStateNumber=-1) const =0>`                       
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetFilterModes <virtual RED_RC RED::IImage::SetFilterModes(FILTER_MODE iMinFilter, FILTER_MODE iMagFilter, const RED::State &iState)=0>`                           
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetBorderColor <virtual RED_RC RED::IImage::GetBorderColor(RED::Color &oBorderColor, int iStateNumber=-1) const =0>`                                               
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetBorderColor <virtual RED_RC RED::IImage::SetBorderColor(const RED::Color &iBorderColor, const RED::State &iState)=0>`                                           
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetAnisotropy <virtual RED_RC RED::IImage::GetAnisotropy(float &oAniso, int iStateNumber=-1) const =0>`                                                            
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetAnisotropy <virtual RED_RC RED::IImage::SetAnisotropy(float iAniso, const RED::State &iState)=0>`                                                               
:cpp:enumerator:`~RED_RC`         :cpp:func:`Clear <virtual RED_RC RED::IImage::Clear(const RED::Color &iClearColor, const RED::State &iState)=0>`                                                              
:cpp:enumerator:`~RED_RC`         :cpp:func:`ColorBalance <virtual RED_RC RED::IImage::ColorBalance(const RED::Color &iColorGain, const RED::Color &iColorOffset, const RED::State &iState)=0>`                 
:cpp:enumerator:`~RED_RC`         :cpp:func:`GreyScale <virtual RED_RC RED::IImage::GreyScale(RED::FORMAT iTargetFormat, GREY_OPERATION iGreyOp, const RED::Object *iSourceImage, const RED::State &iState)=0>` 
:cpp:enumerator:`~RED_RC`         :cpp:func:`Invert <virtual RED_RC RED::IImage::Invert(const RED::Object *iSourceImage, const RED::State &iState)=0>`                                                          
:cpp:enumerator:`~RED_RC`         :cpp:func:`ImageCopyPixels <virtual RED_RC RED::IImage::ImageCopyPixels(const RED::Object *iImage, const RED::State &iState)=0>`                                              
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetPixelSize <virtual RED_RC RED::IImage::GetPixelSize(unsigned int &oSize, RED::FORMAT iFormat) const =0>`                                                        
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetImageByteSize <virtual RED_RC RED::IImage::GetImageByteSize(RED::uint64 &oSize, int iWidth, int iHeight, RED::FORMAT iFormat) const =0>`                        
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetMetalInfo <virtual RED_RC RED::IImage::GetMetalInfo(void *&oMtlTexture) const =0>`                                                                              
:cpp:enumerator:`~RED_RC`         :cpp:func:`GetOpenGLInfo <virtual RED_RC RED::IImage::GetOpenGLInfo(unsigned int &oTextureID) const =0>`                                                                      
void                              :cpp:func:`GetPixelStorage <virtual void RED::IImage::GetPixelStorage(bool &oGPUStorage, bool &oCPUStorage) const =0>`                                                        
:cpp:enumerator:`~RED_RC`         :cpp:func:`SetPixelStorage <virtual RED_RC RED::IImage::SetPixelStorage(bool iGPUStorage, bool iCPUStorage)=0>`                                                               
void                              :cpp:func:`SetLocalTarget <virtual void RED::IImage::SetLocalTarget(RED::TARGET iTarget)=0>`                                                                                  
:cpp:enumerator:`~RED::TARGET`    :cpp:func:`GetLocalTarget <virtual RED::TARGET RED::IImage::GetLocalTarget() const =0>`                                                                                       
void                              :cpp:func:`SetLocalMipmapMode <virtual void RED::IImage::SetLocalMipmapMode(bool iMipmapMode)=0>`                                                                             
bool                              :cpp:func:`GetLocalMipmapMode <virtual bool RED::IImage::GetLocalMipmapMode() const =0>`                                                                                      
void                              :cpp:func:`SetLocalWrapModes <virtual void RED::IImage::SetLocalWrapModes(RED::WRAP_MODE iWrapU, RED::WRAP_MODE iWrapV)=0>`                                                   
void                              :cpp:func:`GetLocalWrapModes <virtual void RED::IImage::GetLocalWrapModes(RED::WRAP_MODE &oWrapU, RED::WRAP_MODE &oWrapV) const =0>`                                          
void                              :cpp:func:`SetLocalFilterModes <virtual void RED::IImage::SetLocalFilterModes(RED::FILTER_MODE iMinFilter, RED::FILTER_MODE iMagFilter)=0>`                                   
void                              :cpp:func:`GetLocalFilterModes <virtual void RED::IImage::GetLocalFilterModes(RED::FILTER_MODE &oMinFilter, RED::FILTER_MODE &oMagFilter) const =0>`                          
void                              :cpp:func:`SetLocalBorderColor <virtual void RED::IImage::SetLocalBorderColor(const RED::Color &iBorderColor)=0>`                                                             
const :doc:`classRED_1_1Color` &  :cpp:func:`GetLocalBorderColor <virtual const RED::Color & RED::IImage::GetLocalBorderColor() const =0>`                                                                      
void                              :cpp:func:`SetLocalAnisotropy <virtual void RED::IImage::SetLocalAnisotropy(float iAnisotropy)=0>`                                                                            
float                             :cpp:func:`GetLocalAnisotropy <virtual float RED::IImage::GetLocalAnisotropy() const =0>`                                                                                     
================================= ==============================================================================================================================================================================

.. cpp:namespace:: nullptr

Detailed Description
====================

.. doxygenclass:: RED::IImage
   :project: RED
   :members:
   :undoc-members:



