RenderMan API  23.0
Public Member Functions | Protected Attributes | List of all members
RixOpacity Class Referenceabstract

#include <RixBxdf.h>

Public Member Functions

 RixOpacity (RixShadingContext const *sCtx, RixBxdfFactory *factory)
 
virtual ~RixOpacity ()
 
RixBxdfFactory * GetBxdfFactory ()
 
RixShadingContext const * GetShadingCtx ()
 
virtual bool GetPresence (float *result)=0
 
virtual bool GetOpacity (RtColorRGB *result)=0
 
virtual void Release ()
 

Protected Attributes

RixShadingContext const * shadingCtx
 
RixBxdfFactory * bxdfFactory
 

Detailed Description

Definition at line 669 of file RixBxdf.h.

Constructor & Destructor Documentation

◆ RixOpacity()

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

Definition at line 672 of file RixBxdf.h.

◆ ~RixOpacity()

virtual RixOpacity::~RixOpacity ( )
inlinevirtual

Definition at line 675 of file RixBxdf.h.

Member Function Documentation

◆ GetBxdfFactory()

RixBxdfFactory* RixOpacity::GetBxdfFactory ( )
inline

Definition at line 677 of file RixBxdf.h.

◆ 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

Definition at line 681 of file RixBxdf.h.

◆ Release()

virtual void RixOpacity::Release ( )
inlinevirtual

Definition at line 711 of file RixBxdf.h.

Member Data Documentation

◆ bxdfFactory

RixBxdfFactory* RixOpacity::bxdfFactory
protected

Definition at line 718 of file RixBxdf.h.

◆ shadingCtx

RixShadingContext const* RixOpacity::shadingCtx
protected

Definition at line 717 of file RixBxdf.h.

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