MobileRT  1.0
A multi platform C++ CPU progressive Ray Tracer.
Components::StaticHaltonSeq Class Referencefinal

#include <StaticHaltonSeq.hpp>

Inheritance diagram for Components::StaticHaltonSeq:
Inheritance graph
Collaboration diagram for Components::StaticHaltonSeq:
Collaboration graph

Public Member Functions

 StaticHaltonSeq ()
 
 StaticHaltonSeq (::std::uint32_t width, ::std::uint32_t height, ::std::uint32_t samples)
 
 StaticHaltonSeq (const StaticHaltonSeq &random)=delete
 
 StaticHaltonSeq (StaticHaltonSeq &&random) noexcept=delete
 
 ~StaticHaltonSeq () final=default
 
StaticHaltonSeqoperator= (const StaticHaltonSeq &random)=delete
 
StaticHaltonSeqoperator= (StaticHaltonSeq &&random) noexcept=delete
 
float getSample (::std::uint32_t sample) final
 
- Public Member Functions inherited from MobileRT::Sampler
 Sampler ()=default
 
 Sampler (::std::uint32_t width, ::std::uint32_t height, ::std::uint32_t samples)
 
 Sampler (const Sampler &sampler)=delete
 
 Sampler (Sampler &&sampler) noexcept=delete
 
virtual ~Sampler ()
 
Sampleroperator= (const Sampler &sampler)=delete
 
Sampleroperator= (Sampler &&sampler) noexcept=delete
 
void resetSampling ()
 
void stopSampling ()
 
float getSample ()
 

Additional Inherited Members

- Public Attributes inherited from MobileRT::Sampler
::std::atomic<::std::uint32_t > sample_ {}
 
const ::std::uint32_t domainSize_ {::std::numeric_limits<::std::uint32_t>::max()}
 
::std::uint32_t samples_ {::std::numeric_limits<::std::uint32_t>::max()}
 
- Protected Member Functions inherited from MobileRT::Sampler
template<const ::std::size_t S>
float getSampleFromArray (const ::std::array< float, S > &values)
 

Detailed Description

This sampler returns the Halton sequence that was pre-calculated.

Constructor & Destructor Documentation

◆ StaticHaltonSeq() [1/4]

StaticHaltonSeq::StaticHaltonSeq ( )
explicit
Here is the call graph for this function:

◆ StaticHaltonSeq() [2/4]

Components::StaticHaltonSeq::StaticHaltonSeq ( ::std::uint32_t  width,
::std::uint32_t  height,
::std::uint32_t  samples 
)
explicit

◆ StaticHaltonSeq() [3/4]

Components::StaticHaltonSeq::StaticHaltonSeq ( const StaticHaltonSeq random)
delete

◆ StaticHaltonSeq() [4/4]

Components::StaticHaltonSeq::StaticHaltonSeq ( StaticHaltonSeq &&  random)
deletenoexcept

◆ ~StaticHaltonSeq()

Components::StaticHaltonSeq::~StaticHaltonSeq ( )
finaldefault

Member Function Documentation

◆ getSample()

float StaticHaltonSeq::getSample ( ::std::uint32_t  sample)
finalvirtual

Calculates a new sample.

Parameters
sampleThe index of the desired sample.
Returns
A random value between 0 and 1.

Implements MobileRT::Sampler.

◆ operator=() [1/2]

StaticHaltonSeq& Components::StaticHaltonSeq::operator= ( const StaticHaltonSeq random)
delete

◆ operator=() [2/2]

StaticHaltonSeq& Components::StaticHaltonSeq::operator= ( StaticHaltonSeq &&  random)
deletenoexcept

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