RenderManAPI  24.0
RixOpacity Class Referenceabstract

#include <RixBxdf.h>

Public Member Functions

 RixOpacity (RixShadingContext const *sCtx, RixBxdfFactory *factory)
 
virtual ~RixOpacity ()
 
RixBxdfFactoryGetBxdfFactory ()
 
RixShadingContext const * GetShadingCtx ()
 
virtual bool GetPresence (float *result)=0
 GetPresence: fill shadingCtx->nPts worth of float presence values. More...
 
virtual bool GetOpacity (RtColorRGB *result)=0
 GetOpacity: fill shadingCtx->nPts worth of RtColor opacity values. More...
 
virtual void Release ()
 

Protected Attributes

RixShadingContext const * shadingCtx
 
RixBxdfFactorybxdfFactory
 

Constructor & Destructor Documentation

◆ RixOpacity()

RixOpacity::RixOpacity ( RixShadingContext const *  sCtx,
RixBxdfFactory factory 
)
inline

◆ ~RixOpacity()

virtual RixOpacity::~RixOpacity ( )
inlinevirtual

Member Function Documentation

◆ GetBxdfFactory()

RixBxdfFactory* RixOpacity::GetBxdfFactory ( )
inline

References bxdfFactory.

◆ GetOpacity()

virtual bool RixOpacity::GetOpacity ( RtColorRGB result)
pure virtual

GetOpacity: fill shadingCtx->nPts worth of RtColor opacity values.

Opacity values are used for transmission rays (usually shadows).

A return code of false signals that the object is fully opaque over the entirety of the shading context, whereas true signals that results are valid and need to be inspected by the renderer. A return value of false may also suggest that no RixOpacity object should have been constructed in the first place (the factory's GetOpacity should have returned NULL).

◆ GetPresence()

virtual bool RixOpacity::GetPresence ( float *  result)
pure virtual

GetPresence: fill shadingCtx->nPts worth of float presence values.

Values of 1 indicate fully present, 0 indicates fully absent, values in between indicate fractional presence and are useful for antialiasing.

A return code of false signals that the object is trivially present over the shading context, whereas true signals that results are valid and need to be inspected by the renderer. A return value of false may also suggest that no RixOpacity object should have been constructed in the first place (the factory's GetOpacity should have returned NULL).

◆ GetShadingCtx()

RixShadingContext const* RixOpacity::GetShadingCtx ( )
inline

References shadingCtx.

◆ Release()

virtual void RixOpacity::Release ( )
inlinevirtual

Member Data Documentation

◆ bxdfFactory

RixBxdfFactory* RixOpacity::bxdfFactory
protected

Referenced by GetBxdfFactory(), and Release().

◆ shadingCtx

RixShadingContext const* RixOpacity::shadingCtx
protected

Referenced by GetShadingCtx().


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