########
IImage2D
########

.. cpp:namespace:: RED::IImage2D

.. default-domain:: cpp

Functions
=========

=============================== ================================================================================================================================================================================================================================================================================================
:doc:`classRED_1_1CID`          :cpp:func:`GetClassID <static RED::CID RED::IImage2D::GetClassID()>`                                                                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetRenderImage <virtual RED_RC RED::IImage2D::SetRenderImage(RED::Object *iVRL, int iWidth, int iHeight, int iXAnchor, int iYAnchor, RED::TARGET iTarget, const RED::State &iState)=0>`                                                                                              
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetRenderDepthImage <virtual RED_RC RED::IImage2D::SetRenderDepthImage(RED::Object *iVRL, int iWidth, int iHeight, int iXAnchor, int iYAnchor, const RED::State &iState)=0>`                                                                                                         
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetNotRenderImage <virtual RED_RC RED::IImage2D::SetNotRenderImage(const RED::State &iState)=0>`                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`       :cpp:func:`IsRenderImage <virtual RED_RC RED::IImage2D::IsRenderImage(bool &oRender, int iStateNumber=-1) const =0>`                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`       :cpp:func:`IsRenderDepthImage <virtual RED_RC RED::IImage2D::IsRenderDepthImage(bool &oDepth, int iStateNumber=-1) const =0>`                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`       :cpp:func:`GetRenderImage <virtual RED_RC RED::IImage2D::GetRenderImage(RED::Object *&oVRL, int &oWidth, int &oHeight, int &oXAnchor, int &oYAnchor, TARGET &oTarget, int iStateNumber=-1) const =0>`                                                                                           
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetPixels <virtual RED_RC RED::IImage2D::SetPixels(const unsigned char *iPixel, RED::FORMAT iFormat, RED::TARGET iTarget, int iWidth, int iHeight, const RED::State &iState)=0>`                                                                                                     
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetPixels <virtual RED_RC RED::IImage2D::SetPixels(RED::TARGET iTarget, const RED::State &iState)=0>`                                                                                                                                                                                
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetCompressedPixels <virtual RED_RC RED::IImage2D::SetCompressedPixels(unsigned char *iPixel, RED::FORMAT iFormat, RED::TARGET iTarget, int iWidth, int iHeight, const RED::State &iState)=0>`                                                                                       
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetCompressedPixels <virtual RED_RC RED::IImage2D::SetCompressedPixels(RED::TARGET iTarget, const RED::State &iState)=0>`                                                                                                                                                            
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetFloatPixels <virtual RED_RC RED::IImage2D::SetFloatPixels(CHANNEL iChannel, const RED::Object *iImage, const RED::State &iState)=0>`                                                                                                                                              
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetPixelChannel <virtual RED_RC RED::IImage2D::SetPixelChannel(CHANNEL iDestChannel, const RED::Object *iSourceImage, CHANNEL iSourceChannel, const RED::State &iState)=0>`                                                                                                          
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetFromPixelShader <virtual RED_RC RED::IImage2D::SetFromPixelShader(RED::FORMAT iFormat, const RED::ShaderProgramID &iPixelShaderId, RED::Object *iResMgr, const RED::Object *iSourceImage, const RED::Vector< RED::RenderShaderParameter > &iParams, const RED::State &iState)=0>` 
:cpp:enumerator:`~RED_RC`       :cpp:func:`NormalMap <virtual RED_RC RED::IImage2D::NormalMap(RED::FORMAT iFormat, RED::TARGET iTarget, float iScaling, const RED::Object *iSourceImage, const RED::State &iState)=0>`                                                                                                          
:cpp:enumerator:`~RED_RC`       :cpp:func:`ScaleNormalMap <virtual RED_RC RED::IImage2D::ScaleNormalMap(RED::FORMAT iFormat, RED::TARGET iTarget, float iScaling, const RED::Object *iSourceImage, const RED::State &iState)=0>`                                                                                                
:cpp:enumerator:`~RED_RC`       :cpp:func:`GetPixels <virtual RED_RC RED::IImage2D::GetPixels(int iStateNumber=-1) const =0>`                                                                                                                                                                                                   
unsigned char *                 :cpp:func:`GetLocalPixels <virtual unsigned char * RED::IImage2D::GetLocalPixels()=0>`                                                                                                                                                                                                          
const unsigned char *           :cpp:func:`GetLocalPixels <virtual const unsigned char * RED::IImage2D::GetLocalPixels() const =0>`                                                                                                                                                                                             
void                            :cpp:func:`GetLocalSize <virtual void RED::IImage2D::GetLocalSize(int &oWidth, int &oHeight) const =0>`                                                                                                                                                                                         
int                             :cpp:func:`GetLocalWidth <virtual int RED::IImage2D::GetLocalWidth() const =0>`                                                                                                                                                                                                                 
int                             :cpp:func:`GetLocalHeight <virtual int RED::IImage2D::GetLocalHeight() const =0>`                                                                                                                                                                                                               
:cpp:enumerator:`~RED::FORMAT`  :cpp:func:`GetLocalFormat <virtual RED::FORMAT RED::IImage2D::GetLocalFormat() const =0>`                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetLocalPixels <virtual RED_RC RED::IImage2D::SetLocalPixels(const unsigned char *iPixel, RED::FORMAT iFormat, int iWidth, int iHeight)=0>`                                                                                                                                          
void                            :cpp:func:`ClearLocalPixels <virtual void RED::IImage2D::ClearLocalPixels()=0>`                                                                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`       :cpp:func:`GetAverageLuminance <virtual RED_RC RED::IImage2D::GetAverageLuminance(float &oAverageLuminance, unsigned int &oSamplesCount, int iStateNumber=-1) const =0>`                                                                                                                        
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetAverageLuminance <virtual RED_RC RED::IImage2D::SetAverageLuminance(float iAverageLuminance, unsigned int iSamplesCount, const RED::State &iState)=0>`                                                                                                                            
:cpp:enumerator:`~RED_RC`       :cpp:func:`GetLogAverageLuminance <virtual RED_RC RED::IImage2D::GetLogAverageLuminance(float &oLogAverageLuminance, unsigned int &oSamplesCount, int iStateNumber=-1) const =0>`                                                                                                               
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetLogAverageLuminance <virtual RED_RC RED::IImage2D::SetLogAverageLuminance(float iLogAverageLuminance, unsigned int iSamplesCount, const RED::State &iState)=0>`                                                                                                                   
:cpp:enumerator:`~RED_RC`       :cpp:func:`GetMinLuminance <virtual RED_RC RED::IImage2D::GetMinLuminance(float &oMinLuminance, int iStateNumber=-1) const =0>`                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetMinLuminance <virtual RED_RC RED::IImage2D::SetMinLuminance(float iMinLuminance, const RED::State &iState)=0>`                                                                                                                                                                    
:cpp:enumerator:`~RED_RC`       :cpp:func:`GetMaxLuminance <virtual RED_RC RED::IImage2D::GetMaxLuminance(float &oMaxLuminance, int iStateNumber=-1) const =0>`                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`       :cpp:func:`SetMaxLuminance <virtual RED_RC RED::IImage2D::SetMaxLuminance(float iMaxLuminance, const RED::State &iState)=0>`                                                                                                                                                                    
=============================== ================================================================================================================================================================================================================================================================================================

.. cpp:namespace:: nullptr

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

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



