####################
IViewpointRenderList
####################

.. cpp:namespace:: RED::IViewpointRenderList

.. default-domain:: cpp

Functions
=========

============================ =======================================================================================================================================================================================================================================================================================================================================================================================
:doc:`classRED_1_1CID`       :cpp:func:`GetClassID <static RED::CID RED::IViewpointRenderList::GetClassID()>`                                                                                                                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetSize <virtual RED_RC RED::IViewpointRenderList::GetSize(int &oWidth, int &oHeight, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetSize <virtual RED_RC RED::IViewpointRenderList::SetSize(int iWidth, int iHeight, const RED::State &iState)=0>`                                                                                                                                                                                                                                                           
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetPixelFormat <virtual RED_RC RED::IViewpointRenderList::GetPixelFormat(RED::FORMAT &oFormat, int iNumColorBuffer, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                         
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetPixelFormat <virtual RED_RC RED::IViewpointRenderList::SetPixelFormat(int iNumColorBuffer, RED::FORMAT iFormat, const RED::State &iState)=0>`                                                                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetHardwareAntiAlias <virtual RED_RC RED::IViewpointRenderList::GetHardwareAntiAlias(int &oMultiSamples, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                    
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetEngineAntiAlias <virtual RED_RC RED::IViewpointRenderList::GetEngineAntiAlias(int &oMultiSamples, bool &oSuperScale, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetEngineAntiAlias <virtual RED_RC RED::IViewpointRenderList::SetEngineAntiAlias(int iMultiSamples, bool iSuperScale, const RED::State &iState)=0>`                                                                                                                                                                                                                         
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetSoftAntiAlias <virtual RED_RC RED::IViewpointRenderList::GetSoftAntiAlias(unsigned int &oAASamplesRate, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetSoftAntiAlias <virtual RED_RC RED::IViewpointRenderList::SetSoftAntiAlias(unsigned int iAASamplesRate, const RED::State &iState)=0>`                                                                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetClearColor <virtual RED_RC RED::IViewpointRenderList::GetClearColor(RED::Color &oColor, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetClearColor <virtual RED_RC RED::IViewpointRenderList::SetClearColor(const RED::Color &iColor, const RED::State &iState)=0>`                                                                                                                                                                                                                                              
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetClearDepth <virtual RED_RC RED::IViewpointRenderList::GetClearDepth(float &oDepth, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetClearDepth <virtual RED_RC RED::IViewpointRenderList::SetClearDepth(float iDepth, const RED::State &iState)=0>`                                                                                                                                                                                                                                                          
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetBackgroundDepth <virtual RED_RC RED::IViewpointRenderList::GetBackgroundDepth(float &oDepth, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                             
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetBackgroundCubeImage <virtual RED_RC RED::IViewpointRenderList::GetBackgroundCubeImage(RED::Object *&oImage, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                              
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetBackgroundCubeImageMatrix <virtual RED_RC RED::IViewpointRenderList::GetBackgroundCubeImageMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetBackground2DImage <virtual RED_RC RED::IViewpointRenderList::GetBackground2DImage(RED::Object *&oImage, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetBackground2DImageMatrix <virtual RED_RC RED::IViewpointRenderList::GetBackground2DImageMatrix(RED::Matrix &oMatrix, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                      
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetBackgroundImagesDirectVisibility <virtual RED_RC RED::IViewpointRenderList::GetBackgroundImagesDirectVisibility(bool &oVisibility, int iStateNumber=-1) const =0>`                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetBackgroundImagesIntensityScale <virtual RED_RC RED::IViewpointRenderList::GetBackgroundImagesIntensityScale(double &oScaleCube, double &oScale2D, int iStateNumber=-1) const =0>`                                                                                                                                                                                        
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetBackgroundImages <virtual RED_RC RED::IViewpointRenderList::SetBackgroundImages(RED::Object *iCubeImage, const RED::Matrix &iCubeMatrix, RED::Object *i2DImage, const RED::Matrix &i2DMatrix, bool iDirectVisibility, double iIntensityScaleCube, double iIntensityScale2D, const RED::State &iState)=0>`                                                                
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointGICaches <virtual RED_RC RED::IViewpointRenderList::GetViewpointGICaches(RED::Vector< RED::Object * > &oGICaches, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                                                                                                      
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointGICaches <virtual RED_RC RED::IViewpointRenderList::SetViewpointGICaches(const RED::Vector< RED::Object * > &iGICaches, RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointGICache <virtual RED_RC RED::IViewpointRenderList::SetViewpointGICache(RED::Object *iGICache, RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSoftImages <virtual RED_RC RED::IViewpointRenderList::GetViewpointSoftImages(RED::Object *&oColor, RED::Object *&oDepth, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                                                                                               
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointSoftImages <virtual RED_RC RED::IViewpointRenderList::SetViewpointSoftImages(RED::Object *iColor, RED::Object *iDepth, RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSoftMatrix <virtual RED_RC RED::IViewpointRenderList::GetViewpointSoftMatrix(RED::Matrix *&oMatrix, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                                                                                                                    
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointSoftMatrix <virtual RED_RC RED::IViewpointRenderList::SetViewpointSoftMatrix(RED::Matrix *iMatrix, RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSoftPixelAnalysisCallback <virtual RED_RC RED::IViewpointRenderList::GetViewpointSoftPixelAnalysisCallback(RED::SOFT_PIXEL_ANALYSIS_CALLBACK &oCallback, void *&oUserData, bool &oTwoSided, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                            
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointSoftPixelAnalysisCallback <virtual RED_RC RED::IViewpointRenderList::SetViewpointSoftPixelAnalysisCallback(RED::SOFT_PIXEL_ANALYSIS_CALLBACK iCallback, void *iUserData, bool iTwoSided, RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                 
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSoftBucketCallback <virtual RED_RC RED::IViewpointRenderList::GetViewpointSoftBucketCallback(RED::SOFT_BUCKET_CALLBACK &oCallback, void *&oUserData, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                                                                   
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointSoftBucketCallback <virtual RED_RC RED::IViewpointRenderList::SetViewpointSoftBucketCallback(RED::SOFT_BUCKET_CALLBACK iCallback, void *iUserData, RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSoftTileOffset <virtual RED_RC RED::IViewpointRenderList::GetViewpointSoftTileOffset(int &oOffsetX, int &oOffsetY, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointSoftTileOffset <virtual RED_RC RED::IViewpointRenderList::SetViewpointSoftTileOffset(RED::Object *iViewpoint, int iOffsetX, int iOffsetY, const RED::State &iState)=0>`                                                                                                                                                                                         
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSoftClipBox <virtual RED_RC RED::IViewpointRenderList::GetViewpointSoftClipBox(double &oBXMin, double &oBXMax, double &oBYMin, double &oBYMax, double &oBZMin, double &oBZMax, RED::Matrix &oMatrix, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                   
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointSoftClipBox <virtual RED_RC RED::IViewpointRenderList::SetViewpointSoftClipBox(double iBXMin, double iBXMax, double iBYMin, double iBYMax, double iBZMin, double iBZMax, const RED::Matrix &iMatrix, RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                     
:cpp:enumerator:`~RED_RC`    :cpp:func:`ResetViewpointSoftClipBox <virtual RED_RC RED::IViewpointRenderList::ResetViewpointSoftClipBox(RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSoftRayProcessingCallbacks <virtual RED_RC RED::IViewpointRenderList::GetViewpointSoftRayProcessingCallbacks(RED::SOFT_RAY_PROCESSING_INTERSECTION_CALLBACK &oIntersectCallback, RED::SOFT_RAY_PROCESSING_SHADING_CALLBACK &oShadingCallback, void *&oUserData, RED::Object *iViewpoint, int iStateNumber)=0>`                                                  
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointSoftRayProcessingCallbacks <virtual RED_RC RED::IViewpointRenderList::SetViewpointSoftRayProcessingCallbacks(RED::SOFT_RAY_PROCESSING_INTERSECTION_CALLBACK iIntersectCallback, RED::SOFT_RAY_PROCESSING_SHADING_CALLBACK iShadingCallback, void *iUserData, RED::Object *iViewpoint, const RED::State &iState)=0>`                                             
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointGeometryDatabase <virtual RED_RC RED::IViewpointRenderList::GetViewpointGeometryDatabase(RED::Object *&oGeometryDatabase, RED::Object *iViewpoint, int iStateNumber=-1) const =0>`                                                                                                                                                                              
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpoint <virtual RED_RC RED::IViewpointRenderList::GetViewpoint(RED::Object *&oVP, int iNumber, RED::VRL_SORT iListID, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointList <virtual RED_RC RED::IViewpointRenderList::GetViewpointList(RED::Vector< RED::Object * > *&oVP, RED::VRL_SORT iListId, int iStateNumber=-1) const =0>`                                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointsCount <virtual RED_RC RED::IViewpointRenderList::GetViewpointsCount(int &oCount, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                               
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpoint <virtual RED_RC RED::IViewpointRenderList::GetViewpoint(RED::Object *&oVp, int iNumber, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                        
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSortList <virtual RED_RC RED::IViewpointRenderList::GetViewpointSortList(RED::VRL_SORT &oList, int iNumber, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`    :cpp:func:`FindViewpoint <virtual RED_RC RED::IViewpointRenderList::FindViewpoint(bool &oFound, RED::Object *iViewpoint, int iStateNumber=- 1) const =0>`                                                                                                                                                                                                                              
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointBoundaries <virtual RED_RC RED::IViewpointRenderList::GetViewpointBoundaries(const RED::Object *iViewpoint, int &oXAnchor, int &oYAnchor, int &oXSize, int &oYSize, int iStateNumber=-1) const =0>`                                                                                                                                                             
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointSizingModes <virtual RED_RC RED::IViewpointRenderList::GetViewpointSizingModes(RED::Object *iViewpoint, int &oAnchoringMode, int &oSizingMode, int iStateNumber=-1) const =0>`                                                                                                                                                                                  
:cpp:enumerator:`~RED_RC`    :cpp:func:`InsertViewpoint <virtual RED_RC RED::IViewpointRenderList::InsertViewpoint(RED::Object *iViewpoint, RED::VRL_SORT iFrontSceneOrBack, RED::LIST_POS iFirstOrLastInList, int iXAnchor, int iYAnchor, int iXSize, int iYSize, float iXAsymmetricOffset, float iYAsymmetricOffset, RED::VRL_SIZEPOS iAnchoringMode, RED::VRL_SIZEPOS iSizingMode, const RED::State &iState)=0>` 
:cpp:enumerator:`~RED_RC`    :cpp:func:`InsertViewpoint <virtual RED_RC RED::IViewpointRenderList::InsertViewpoint(RED::Object *iViewpoint, RED::VRL_SORT iFrontSceneOrBack, int iPosition, int iXAnchor, int iYAnchor, int iXSize, int iYSize, float iXAsymmetricOffset, float iYAsymmetricOffset, RED::VRL_SIZEPOS iAnchoringMode, RED::VRL_SIZEPOS iSizingMode, const RED::State &iState)=0>`                    
:cpp:enumerator:`~RED_RC`    :cpp:func:`InsertViewpoint <virtual RED_RC RED::IViewpointRenderList::InsertViewpoint(RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                                                                                                           
:cpp:enumerator:`~RED_RC`    :cpp:func:`RemoveViewpoint <virtual RED_RC RED::IViewpointRenderList::RemoveViewpoint(RED::Object *iViewpoint, const RED::State &iState)=0>`                                                                                                                                                                                                                                           
:cpp:enumerator:`~RED_RC`    :cpp:func:`RemoveViewpointList <virtual RED_RC RED::IViewpointRenderList::RemoveViewpointList(RED::VRL_SORT iList, const RED::State &iState)=0>`                                                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointBoundaries <virtual RED_RC RED::IViewpointRenderList::SetViewpointBoundaries(RED::Object *iViewpoint, int iXAnchor, int iYAnchor, int iXSize, int iYSize, int iAnchoringMode, int iSizingMode, const RED::State &iState)=0>`                                                                                                                                    
:doc:`classRED_1_1Object` *  :cpp:func:`GetRenderImage <virtual RED::Object * RED::IViewpointRenderList::GetRenderImage(int iColorBufferNumber=0) const =0>`                                                                                                                                                                                                                                                        
:doc:`classRED_1_1Object` *  :cpp:func:`GetRenderDepthImage <virtual RED::Object * RED::IViewpointRenderList::GetRenderDepthImage() const =0>`                                                                                                                                                                                                                                                                      
int                          :cpp:func:`GetRenderImagesCount <virtual int RED::IViewpointRenderList::GetRenderImagesCount() const =0>`                                                                                                                                                                                                                                                                              
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewpointAsymmetricOffsets <virtual RED_RC RED::IViewpointRenderList::GetViewpointAsymmetricOffsets(RED::Object *iViewpoint, float &oXAsymmetricOffset, float &oYAsymmetricOffset, int iStateNumber=-1) const =0>`                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetViewpointAsymmetricOffsets <virtual RED_RC RED::IViewpointRenderList::SetViewpointAsymmetricOffsets(RED::Object *iViewpoint, float iXAsymmetricOffset, float iYAsymmetricOffset, const RED::State &iState)=0>`                                                                                                                                                           
:cpp:enumerator:`~RED_RC`    :cpp:func:`Activate <virtual RED_RC RED::IViewpointRenderList::Activate(bool iOnOff, const RED::State &iState)=0>`                                                                                                                                                                                                                                                                     
:cpp:enumerator:`~RED_RC`    :cpp:func:`IsActivated <virtual RED_RC RED::IViewpointRenderList::IsActivated(bool &oOnOff, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetMustClear <virtual RED_RC RED::IViewpointRenderList::SetMustClear(bool iClear, const RED::State &iState)=0>`                                                                                                                                                                                                                                                             
:cpp:enumerator:`~RED_RC`    :cpp:func:`MustClear <virtual RED_RC RED::IViewpointRenderList::MustClear(bool &oMustClear, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                                            
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetHDROverride <virtual RED_RC RED::IViewpointRenderList::SetHDROverride(bool iOverride, int iHDRValue, const RED::State &iState)=0>`                                                                                                                                                                                                                                       
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetHDROverride <virtual RED_RC RED::IViewpointRenderList::GetHDROverride(bool &oOverride, int &oHDRValue, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`    :cpp:func:`SetStereo <virtual RED_RC RED::IViewpointRenderList::SetStereo(float iInteraxialDistance, float iScreenDepth, const RED::State &iState)=0>`                                                                                                                                                                                                                                 
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetStereo <virtual RED_RC RED::IViewpointRenderList::GetStereo(float &oInteraxialDistance, float &oScreenDepth, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                             
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewportMatrix <virtual RED_RC RED::IViewpointRenderList::GetViewportMatrix(RED::Matrix &oViewport, RED::Object *iCamera, int iStateNumber=-1) const =0>`                                                                                                                                                                                                                
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetViewProjectionViewportMatrix <virtual RED_RC RED::IViewpointRenderList::GetViewProjectionViewportMatrix(RED::Matrix &oVPV, const RED::Object *iCamera, int iStateNumber=-1) const =0>`                                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetFloatingViewProjectionViewportMatrix <virtual RED_RC RED::IViewpointRenderList::GetFloatingViewProjectionViewportMatrix(RED::Matrix &oVPV, const RED::Object *iCamera, int iStateNumber=-1) const =0>`                                                                                                                                                                   
:cpp:enumerator:`~RED_RC`    :cpp:func:`GetInverseProjectionViewportMatrix <virtual RED_RC RED::IViewpointRenderList::GetInverseProjectionViewportMatrix(RED::Matrix &oIPV, const RED::Object *iCamera, int iStateNumber=-1) const =0>`                                                                                                                                                                             
============================ =======================================================================================================================================================================================================================================================================================================================================================================================

.. cpp:namespace:: nullptr

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

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



