ph::SampleLocation Class Reference

#include <SampleLocation.h>

Public Member Functions
	SampleLocation (const SampleLocation &other)
SampleLocation	getUvwScaled (const math::Vector3R &scale) const
math::EColorUsage	expectedUsage () const
	Gets expected type of the usage for the sample.
	SampleLocation (const math::Vector3R &uvw, math::EColorUsage usage)
	Constructs a sample location at \( (u, v, (w)) \).
	SampleLocation (const math::Vector2R &uv, math::EColorUsage usage)
	SampleLocation (const HitDetail &hit)
	Constructs a sample location from hit information.
	SampleLocation (const HitDetail &hit, math::EColorUsage usage)
math::Vector3R	uvw () const
	Gets and sets the uvw coordinates of this sample location.
math::Vector2R	uv () const
void	setUvw (const math::Vector3R &uvw)
void	setUv (const math::Vector2R &uv)

Detailed Description

This class provides a temporal, higher order abstraction over data regarding ray-hit information. This abstraction layer is tailored towards texture sampling and shall not be used in other circumstances. The philosophy of this abstraction layer is that texture sampling processes should not care about the context of a hit, but focus on the actual data of the target point.

Constructor & Destructor Documentation

SampleLocation() [1/5]

ph::SampleLocation::SampleLocation ( const math::Vector3R & uvw, math::EColorUsage usage )

inline

Constructs a sample location at \( (u, v, (w)) \).

SampleLocation() [2/5]

ph::SampleLocation::SampleLocation ( const math::Vector2R & uv, math::EColorUsage usage )

inline

SampleLocation() [3/5]

ph::SampleLocation::SampleLocation ( const HitDetail & hit )

inlineexplicit

Constructs a sample location from hit information.

SampleLocation() [4/5]

ph::SampleLocation::SampleLocation ( const HitDetail & hit, math::EColorUsage usage )

inline

SampleLocation() [5/5]

ph::SampleLocation::SampleLocation ( const SampleLocation & other )

inline

Member Function Documentation

expectedUsage()

math::EColorUsage ph::SampleLocation::expectedUsage ( ) const

inline

Gets expected type of the usage for the sample.

getUvwScaled()

SampleLocation ph::SampleLocation::getUvwScaled ( const math::Vector3R & scale ) const

inline

setUv()

void ph::SampleLocation::setUv ( const math::Vector2R & uv )

inline

setUvw()

void ph::SampleLocation::setUvw ( const math::Vector3R & uvw )

inline

uv()

math::Vector2R ph::SampleLocation::uv ( ) const

inline

uvw()

math::Vector3R ph::SampleLocation::uvw ( ) const

inline

Gets and sets the uvw coordinates of this sample location.

---

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

• Source/Core/Texture/SampleLocation.h