RenderManAPI  24.0
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
RixRNG Class Reference

All-inlined interface for generating sample points for use by Monte Carlo integration and multiple-importance sampling. More...

#include <RixRNG.h>

Classes

class  Generator
 
class  ProgressiveSampler
 
struct  SampleCtx
 SampleCtx identifies a sample domain (an index into an arbitrary scheme of sample points). More...
 

Public Types

enum  Scramble : unsigned
 

Public Member Functions

 RixRNG (Generator const *imp, unsigned scaSize=0)
 
 RixRNG (Generator const *imp, unsigned scaSize, SampleCtx *sca)
 
 RixRNG (RixRNG const *parent, unsigned scaSize, SampleCtx *sca)
 
 RixRNG (RixRNG const *parent, SampleCtx *sca, unsigned scaSize)
 
 RixRNG (RixRNG const *parent, SampleCtx *sca, unsigned scaSize, Scramble scramble)
 
 RixRNG (RixRNG const *parent, SampleCtx *sca, unsigned scaSize, Scramble scramble, unsigned nsamps)
 
 RixRNG (RixRNG const *parent, SampleCtx *sca, unsigned scaSize, Scramble scramble, unsigned sampleid, bool doDistrib)
 
RixRNG GetSlice (SampleCtx *sca, unsigned index) const
 
virtual ~RixRNG ()
 
SampleCtx & GetSampleCtx (unsigned i)
 
float GenerateSample1D (unsigned i) const
 
RtFloat2 GenerateSample2D (unsigned i) const
 
RtFloat2 GenerateScrambledSample2D (unsigned i) const
 
RtFloat3 GenerateSample3D (unsigned i) const
 
float GenerateSample1D (SampleCtx &c, unsigned i) const
 
RtFloat2 GenerateSample2D (SampleCtx &c, unsigned i) const
 
RtFloat2 GenerateScrambledSample2D (SampleCtx &c, unsigned i) const
 
RtFloat3 GenerateSample3D (SampleCtx &c, unsigned i) const
 
void GenerateSamples1D (float *xis) const
 
void GenerateSamples2D (RtFloat2 *xis) const
 
void GenerateScrambledSamples2D (RtFloat2 *xis) const
 
void GenerateSamples3D (RtFloat3 *xis) const
 
float DrawSample1D (unsigned i) const
 
RtFloat2 DrawSample2D (unsigned i) const
 
RtFloat2 DrawScrambledSample2D (unsigned i) const
 
RtFloat3 DrawSample3D (unsigned i) const
 
float DrawSample1D (const SampleCtx &c, unsigned i) const
 
RtFloat2 DrawSample2D (const SampleCtx &c, unsigned i) const
 
RtFloat2 DrawScrambledSample2D (const SampleCtx &c, unsigned i) const
 
RtFloat3 DrawSample3D (const SampleCtx &c, unsigned i) const
 
void DrawSamples1D (float *xis) const
 
void DrawSamples2D (RtFloat2 *xis) const
 
void DrawSamples3D (RtFloat3 *xis) const
 
void IncrementSampleIds () const
 
SampleCtx NewDomain (unsigned i, Scramble scramble) const
 
SampleCtx NewDomainDistrib (unsigned i, Scramble scramble, unsigned newsampleid) const
 
SampleCtx NewDomainSplit (unsigned i, Scramble scramble, unsigned newnumsamples) const
 
void NewDomains (Scramble scramble) const
 
void NewDomainsDistrib (Scramble scramble, unsigned newsampleid) const
 
void NewDomainsSplit (Scramble scramble, unsigned newnumsamples) const
 
void NewDomains (Scramble scramble, RixRNG *newRng) const
 
void NewDomainsDistrib (Scramble scramble, unsigned newsampleid, RixRNG *newRng) const
 
void NewDomainsSplit (Scramble scramble, unsigned newnumsamples, RixRNG *newRng) const
 

Public Attributes

unsigned numPts
 
SampleCtx * sampleCtxArray
 
Generator const * impl
 

Detailed Description

All-inlined interface for generating sample points for use by Monte Carlo integration and multiple-importance sampling.

Samples are distributed within an N-dimension domain characterized by the combination of patternid and sampleid, stratified in a progressive manner. Resulting samples reside within the [0,1)^N region.

The RixRNG class is a wrapper around an array of per-point sample contexts (RixRNG::SampleCtx). There is typically one SampleCtx for each point in a ray shading batch. The RixRNG wrapper class makes it convenient to generate sample points (or new sample domains) for an entire ray shading batch with just a single function call.

Member Enumeration Documentation

◆ Scramble

enum RixRNG::Scramble : unsigned
strong

Constructor & Destructor Documentation

◆ RixRNG() [1/7]

RixRNG::RixRNG ( Generator const *  imp,
unsigned  scaSize = 0 
)
inline

◆ RixRNG() [2/7]

RixRNG::RixRNG ( Generator const *  imp,
unsigned  scaSize,
SampleCtx *  sca 
)
inline

◆ RixRNG() [3/7]

RixRNG::RixRNG ( RixRNG const *  parent,
unsigned  scaSize,
SampleCtx *  sca 
)
inline

◆ RixRNG() [4/7]

RixRNG::RixRNG ( RixRNG const *  parent,
SampleCtx *  sca,
unsigned  scaSize 
)
inline

◆ RixRNG() [5/7]

RixRNG::RixRNG ( RixRNG const *  parent,
SampleCtx *  sca,
unsigned  scaSize,
Scramble  scramble 
)
inline

References NewDomains(), and numPts.

◆ RixRNG() [6/7]

RixRNG::RixRNG ( RixRNG const *  parent,
SampleCtx *  sca,
unsigned  scaSize,
Scramble  scramble,
unsigned  nsamps 
)
inline

References NewDomainsSplit(), and numPts.

◆ RixRNG() [7/7]

RixRNG::RixRNG ( RixRNG const *  parent,
SampleCtx *  sca,
unsigned  scaSize,
Scramble  scramble,
unsigned  sampleid,
bool  doDistrib 
)
inline

References NewDomains(), NewDomainsDistrib(), and numPts.

◆ ~RixRNG()

virtual RixRNG::~RixRNG ( )
inlinevirtual

Member Function Documentation

◆ DrawSample1D() [1/2]

float RixRNG::DrawSample1D ( unsigned  i) const
inline

References impl, RixRNG::Generator::Sample1D(), and sampleCtxArray.

◆ DrawSample1D() [2/2]

float RixRNG::DrawSample1D ( const SampleCtx &  c,
unsigned  i 
) const
inline

References impl, and RixRNG::Generator::Sample1D().

◆ DrawSample2D() [1/2]

RtFloat2 RixRNG::DrawSample2D ( unsigned  i) const
inline

References impl, RixRNG::Generator::Sample2D(), and sampleCtxArray.

◆ DrawSample2D() [2/2]

RtFloat2 RixRNG::DrawSample2D ( const SampleCtx &  c,
unsigned  i 
) const
inline

References impl, and RixRNG::Generator::Sample2D().

◆ DrawSample3D() [1/2]

RtFloat3 RixRNG::DrawSample3D ( unsigned  i) const
inline

References impl, RixRNG::Generator::Sample3D(), and sampleCtxArray.

◆ DrawSample3D() [2/2]

RtFloat3 RixRNG::DrawSample3D ( const SampleCtx &  c,
unsigned  i 
) const
inline

References impl, and RixRNG::Generator::Sample3D().

◆ DrawSamples1D()

void RixRNG::DrawSamples1D ( float *  xis) const
inline

References impl, RixRNG::Generator::MultiSample1D(), numPts, and sampleCtxArray.

◆ DrawSamples2D()

void RixRNG::DrawSamples2D ( RtFloat2 *  xis) const
inline

References impl, RixRNG::Generator::MultiSample2D(), numPts, and sampleCtxArray.

◆ DrawSamples3D()

void RixRNG::DrawSamples3D ( RtFloat3 *  xis) const
inline

References impl, RixRNG::Generator::MultiSample3D(), numPts, and sampleCtxArray.

◆ DrawScrambledSample2D() [1/2]

RtFloat2 RixRNG::DrawScrambledSample2D ( unsigned  i) const
inline

References impl, sampleCtxArray, and RixRNG::Generator::ScrambledSample2D().

◆ DrawScrambledSample2D() [2/2]

RtFloat2 RixRNG::DrawScrambledSample2D ( const SampleCtx &  c,
unsigned  i 
) const
inline

References impl, and RixRNG::Generator::ScrambledSample2D().

◆ GenerateSample1D() [1/2]

float RixRNG::GenerateSample1D ( unsigned  i) const
inline

References impl, RixRNG::Generator::Sample1D(), sampleCtxArray, and RixRNG::SampleCtx::sampleid.

◆ GenerateSample1D() [2/2]

float RixRNG::GenerateSample1D ( SampleCtx &  c,
unsigned  i 
) const
inline

References impl, RixRNG::Generator::Sample1D(), and RixRNG::SampleCtx::sampleid.

◆ GenerateSample2D() [1/2]

RtFloat2 RixRNG::GenerateSample2D ( unsigned  i) const
inline

References impl, RixRNG::Generator::Sample2D(), sampleCtxArray, and RixRNG::SampleCtx::sampleid.

◆ GenerateSample2D() [2/2]

RtFloat2 RixRNG::GenerateSample2D ( SampleCtx &  c,
unsigned  i 
) const
inline

References impl, RixRNG::Generator::Sample2D(), and RixRNG::SampleCtx::sampleid.

◆ GenerateSample3D() [1/2]

RtFloat3 RixRNG::GenerateSample3D ( unsigned  i) const
inline

References impl, RixRNG::Generator::Sample3D(), sampleCtxArray, and RixRNG::SampleCtx::sampleid.

◆ GenerateSample3D() [2/2]

RtFloat3 RixRNG::GenerateSample3D ( SampleCtx &  c,
unsigned  i 
) const
inline

References impl, RixRNG::Generator::Sample3D(), and RixRNG::SampleCtx::sampleid.

◆ GenerateSamples1D()

void RixRNG::GenerateSamples1D ( float *  xis) const
inline

References impl, IncrementSampleIds(), RixRNG::Generator::MultiSample1D(), numPts, and sampleCtxArray.

◆ GenerateSamples2D()

void RixRNG::GenerateSamples2D ( RtFloat2 *  xis) const
inline

References impl, IncrementSampleIds(), RixRNG::Generator::MultiSample2D(), numPts, and sampleCtxArray.

◆ GenerateSamples3D()

void RixRNG::GenerateSamples3D ( RtFloat3 *  xis) const
inline

References impl, IncrementSampleIds(), RixRNG::Generator::MultiSample3D(), numPts, and sampleCtxArray.

◆ GenerateScrambledSample2D() [1/2]

RtFloat2 RixRNG::GenerateScrambledSample2D ( unsigned  i) const
inline

References impl, sampleCtxArray, RixRNG::SampleCtx::sampleid, and RixRNG::Generator::ScrambledSample2D().

◆ GenerateScrambledSample2D() [2/2]

RtFloat2 RixRNG::GenerateScrambledSample2D ( SampleCtx &  c,
unsigned  i 
) const
inline

References impl, RixRNG::SampleCtx::sampleid, and RixRNG::Generator::ScrambledSample2D().

◆ GenerateScrambledSamples2D()

void RixRNG::GenerateScrambledSamples2D ( RtFloat2 *  xis) const
inline

References impl, IncrementSampleIds(), RixRNG::Generator::MultiScrambledSample2D(), numPts, and sampleCtxArray.

◆ GetSampleCtx()

SampleCtx& RixRNG::GetSampleCtx ( unsigned  i)
inline

References sampleCtxArray.

◆ GetSlice()

RixRNG RixRNG::GetSlice ( SampleCtx *  sca,
unsigned  index 
) const
inline

References impl, numPts, and sampleCtxArray.

◆ IncrementSampleIds()

void RixRNG::IncrementSampleIds ( ) const
inline

References numPts, and sampleCtxArray.

Referenced by GenerateSamples1D(), GenerateSamples2D(), GenerateSamples3D(), and GenerateScrambledSamples2D().

◆ NewDomain()

SampleCtx RixRNG::NewDomain ( unsigned  i,
Scramble  scramble 
) const
inline

References RixRNG::SampleCtx::NewDomain(), and sampleCtxArray.

◆ NewDomainDistrib()

SampleCtx RixRNG::NewDomainDistrib ( unsigned  i,
Scramble  scramble,
unsigned  newsampleid 
) const
inline

References RixRNG::SampleCtx::NewDomainDistrib(), and sampleCtxArray.

◆ NewDomains() [1/2]

void RixRNG::NewDomains ( Scramble  scramble) const
inline

References RixRNG::SampleCtx::NewDomain(), numPts, and sampleCtxArray.

Referenced by RixRNG().

◆ NewDomains() [2/2]

void RixRNG::NewDomains ( Scramble  scramble,
RixRNG *  newRng 
) const
inline

References numPts.

◆ NewDomainsDistrib() [1/2]

void RixRNG::NewDomainsDistrib ( Scramble  scramble,
unsigned  newsampleid 
) const
inline

References RixRNG::SampleCtx::NewDomainDistrib(), numPts, and sampleCtxArray.

Referenced by RixRNG().

◆ NewDomainsDistrib() [2/2]

void RixRNG::NewDomainsDistrib ( Scramble  scramble,
unsigned  newsampleid,
RixRNG *  newRng 
) const
inline

◆ NewDomainSplit()

SampleCtx RixRNG::NewDomainSplit ( unsigned  i,
Scramble  scramble,
unsigned  newnumsamples 
) const
inline

References RixRNG::SampleCtx::NewDomainSplit(), and sampleCtxArray.

◆ NewDomainsSplit() [1/2]

void RixRNG::NewDomainsSplit ( Scramble  scramble,
unsigned  newnumsamples 
) const
inline

References RixRNG::SampleCtx::NewDomainSplit(), numPts, and sampleCtxArray.

Referenced by RixRNG().

◆ NewDomainsSplit() [2/2]

void RixRNG::NewDomainsSplit ( Scramble  scramble,
unsigned  newnumsamples,
RixRNG *  newRng 
) const
inline

Member Data Documentation

◆ impl

Generator const* RixRNG::impl

Referenced by DrawSample1D(), DrawSample2D(), DrawSample3D(), DrawSamples1D(), DrawSamples2D(), DrawSamples3D(), DrawScrambledSample2D(), GenerateSample1D(), GenerateSample2D(), GenerateSample3D(), GenerateSamples1D(), GenerateSamples2D(), GenerateSamples3D(), GenerateScrambledSample2D(), GenerateScrambledSamples2D(), and GetSlice().

◆ numPts

unsigned RixRNG::numPts

Referenced by DrawSamples1D(), DrawSamples2D(), DrawSamples3D(), GenerateSamples1D(), GenerateSamples2D(), GenerateSamples3D(), GenerateScrambledSamples2D(), GetSlice(), IncrementSampleIds(), NewDomains(), NewDomainsDistrib(), NewDomainsSplit(), RixRNG(), RixRNG::ProgressiveSampler::Sample2D(), and RixRNG::ProgressiveSampler::Sample3D().

◆ sampleCtxArray

SampleCtx* RixRNG::sampleCtxArray

Referenced by DrawSample1D(), DrawSample2D(), DrawSample3D(), DrawSamples1D(), DrawSamples2D(), DrawSamples3D(), DrawScrambledSample2D(), GenerateSample1D(), GenerateSample2D(), GenerateSample3D(), GenerateSamples1D(), GenerateSamples2D(), GenerateSamples3D(), GenerateScrambledSample2D(), GenerateScrambledSamples2D(), GetSampleCtx(), GetSlice(), IncrementSampleIds(), NewDomain(), NewDomainDistrib(), NewDomains(), NewDomainsDistrib(), NewDomainSplit(), NewDomainsSplit(), RixRNG::ProgressiveSampler::Sample1D(), RixRNG::ProgressiveSampler::Sample2D(), and RixRNG::ProgressiveSampler::Sample3D().

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