Photon Engine 2.0.0-beta
A physically based renderer.
Loading...
Searching...
No Matches
ph::RasterImageBase Class Referenceabstract

#include <RasterImageBase.h>

Inheritance diagram for ph::RasterImageBase:
ph::Image ph::TSdlResourceBase< ESdlTypeCategory::Ref_Image > ph::SdlResourceBase ph::ISdlResource ph::RasterFileImage

Public Member Functions

std::shared_ptr< TTexture< Image::ArrayType > > genNumericTexture (const CookingContext &ctx) override=0
 
std::shared_ptr< TTexture< math::Spectrum > > genColorTexture (const CookingContext &ctx) override=0
 
math::TVector2< uint32 > getResolution () const
 
EImageSampleMode getSampleMode () const
 
EImageWrapMode getHorizontalWrapMode () const
 
EImageWrapMode getVerticalWrapMode () const
 
RasterImageBasesetSampleMode (EImageSampleMode mode)
 
RasterImageBasesetWrapMode (EImageWrapMode mode)
 
RasterImageBasesetWrapMode (EImageWrapMode horizontalWrapMode, EImageWrapMode verticalWrapMode)
 
 PH_DEFINE_SDL_CLASS (TSdlOwnerClass< RasterImageBase >)
 
- Public Member Functions inherited from ph::Image
 PH_DEFINE_SDL_CLASS (TSdlOwnerClass< Image >)
 
- Public Member Functions inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Image >
ESdlTypeCategory getDynamicCategory () const override
 
- Public Member Functions inherited from ph::SdlResourceBase
SdlResourceId getId () const override
 Get the unique ID of this resource. The returned ID is guaranteed to be unique in the current process. Newly created resource cannot have an ID that has been used by a previous resource, even if the previous resource has ended its life cycle. See SdlResourceId.h for some utilities.
 
- Public Member Functions inherited from ph::ISdlResource
 ISdlResource (const ISdlResource &other)=default
 
 ISdlResource (ISdlResource &&other)=default
 
virtual ~ISdlResource ()=default
 
ISdlResourceoperator= (const ISdlResource &rhs)=default
 
ISdlResourceoperator= (ISdlResource &&rhs)=default
 
virtual const SdlClassgetDynamicSdlClass () const
 Get runtime SDL class of the resource.
 
virtual bool isInlinable () const
 

Protected Member Functions

RasterImageBasesetResolution (math::TVector2< uint32 > resolution)
 
- Protected Member Functions inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Image >
 TSdlResourceBase ()=default
 
 TSdlResourceBase (const TSdlResourceBase &other)=default
 
 TSdlResourceBase (TSdlResourceBase &&other)=default
 
TSdlResourceBaseoperator= (const TSdlResourceBase &rhs)=default
 
TSdlResourceBaseoperator= (TSdlResourceBase &&rhs)=default
 
- Protected Member Functions inherited from ph::SdlResourceBase
 SdlResourceBase ()
 
 SdlResourceBase (const SdlResourceBase &other)
 
 SdlResourceBase (SdlResourceBase &&other)=default
 
SdlResourceBaseoperator= (const SdlResourceBase &rhs)
 
SdlResourceBaseoperator= (SdlResourceBase &&rhs)=default
 
- Protected Member Functions inherited from ph::ISdlResource
 ISdlResource ()=default
 

Additional Inherited Members

- Public Types inherited from ph::Image
using ArrayType = math::TArithmeticArray<float64, PH_NUMERIC_IMAGE_MAX_ELEMENTS>
 
- Static Public Attributes inherited from ph::Image
static constexpr auto ARRAY_SIZE = ArrayType::NUM_ELEMENTS
 
- Static Public Attributes inherited from ph::TSdlResourceBase< ESdlTypeCategory::Ref_Image >
static constexpr ESdlTypeCategory CATEGORY
 Static category information of the resource. This static category information is required by ISdlResource. See its documentation for more details.
 

Member Function Documentation

◆ genColorTexture()

std::shared_ptr< TTexture< math::Spectrum > > ph::RasterImageBase::genColorTexture ( const CookingContext & ctx)
overridepure virtual

Color textures are expected to be used where spectral distribution is involved. Color space transformations will take place if required. It is generally not recommended to use color texture to represent data that need to be precisely preserved (e.g., normal map).

Implements ph::Image.

Implemented in ph::RasterFileImage.

◆ genNumericTexture()

std::shared_ptr< TTexture< Image::ArrayType > > ph::RasterImageBase::genNumericTexture ( const CookingContext & ctx)
overridepure virtual

When generating numeric textures, the convention is that the image will be treated as if raw values are used. Numeric textures are expected to be used as part of a general mathematical operation.

Implements ph::Image.

Implemented in ph::RasterFileImage.

◆ getHorizontalWrapMode()

EImageWrapMode ph::RasterImageBase::getHorizontalWrapMode ( ) const

◆ getResolution()

math::TVector2< uint32 > ph::RasterImageBase::getResolution ( ) const

◆ getSampleMode()

EImageSampleMode ph::RasterImageBase::getSampleMode ( ) const

◆ getVerticalWrapMode()

EImageWrapMode ph::RasterImageBase::getVerticalWrapMode ( ) const

◆ PH_DEFINE_SDL_CLASS()

ph::RasterImageBase::PH_DEFINE_SDL_CLASS ( TSdlOwnerClass< RasterImageBase > )
inline

◆ setResolution()

RasterImageBase & ph::RasterImageBase::setResolution ( math::TVector2< uint32 > resolution)
protected

◆ setSampleMode()

RasterImageBase & ph::RasterImageBase::setSampleMode ( EImageSampleMode mode)

◆ setWrapMode() [1/2]

RasterImageBase & ph::RasterImageBase::setWrapMode ( EImageWrapMode horizontalWrapMode,
EImageWrapMode verticalWrapMode )

◆ setWrapMode() [2/2]

RasterImageBase & ph::RasterImageBase::setWrapMode ( EImageWrapMode mode)

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