ph::RasterFileImage Class Reference

#include <RasterFileImage.h>

Inheritance diagram for ph::RasterFileImage:

Public Member Functions
std::shared_ptr< TTexture< Image::ArrayType > >	genNumericTexture (const CookingContext &ctx) override
std::shared_ptr< TTexture< math::Spectrum > >	genColorTexture (const CookingContext &ctx) override
RegularPicture	loadRegularPicture () const
void	setFilePath (Path filePath)
	PH_DEFINE_SDL_CLASS (TSdlOwnerClass< RasterFileImage >)
Public Member Functions inherited from ph::RasterImageBase
math::TVector2< uint32 >	getResolution () const
EImageSampleMode	getSampleMode () const
EImageWrapMode	getHorizontalWrapMode () const
EImageWrapMode	getVerticalWrapMode () const
RasterImageBase &	setSampleMode (EImageSampleMode mode)
RasterImageBase &	setWrapMode (EImageWrapMode mode)
RasterImageBase &	setWrapMode (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
ISdlResource &	operator= (const ISdlResource &rhs)=default
ISdlResource &	operator= (ISdlResource &&rhs)=default
virtual const SdlClass *	getDynamicSdlClass () const
	Get runtime SDL class of the resource.
virtual bool	isInlinable () const

Protected Member Functions
std::shared_ptr< PixelBuffer2D >	loadPixelBuffer (const CookingContext &ctx, math::EColorSpace *out_colorSpace=nullptr, pixel_texture::EPixelLayout *out_pixelLayout=nullptr) const
pixel_texture::ESampleMode	getTextureSampleMode () const
pixel_texture::EWrapMode	getTextureWrapModeS () const
pixel_texture::EWrapMode	getTextureWrapModeT () const
Protected Member Functions inherited from ph::RasterImageBase
RasterImageBase &	setResolution (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
TSdlResourceBase &	operator= (const TSdlResourceBase &rhs)=default
TSdlResourceBase &	operator= (TSdlResourceBase &&rhs)=default
Protected Member Functions inherited from ph::SdlResourceBase
	SdlResourceBase ()
	SdlResourceBase (const SdlResourceBase &other)
	SdlResourceBase (SdlResourceBase &&other)=default
SdlResourceBase &	operator= (const SdlResourceBase &rhs)
SdlResourceBase &	operator= (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::RasterFileImage::genColorTexture ( const CookingContext & ctx )

overridevirtual

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::RasterImageBase.

genNumericTexture()

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

overridevirtual

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::RasterImageBase.

getTextureSampleMode()

pixel_texture::ESampleMode ph::RasterFileImage::getTextureSampleMode ( ) const

protected

getTextureWrapModeS()

pixel_texture::EWrapMode ph::RasterFileImage::getTextureWrapModeS ( ) const

protected

getTextureWrapModeT()

pixel_texture::EWrapMode ph::RasterFileImage::getTextureWrapModeT ( ) const

protected

loadPixelBuffer()

std::shared_ptr< PixelBuffer2D > ph::RasterFileImage::loadPixelBuffer ( const CookingContext & ctx, math::EColorSpace * out_colorSpace = nullptr, pixel_texture::EPixelLayout * out_pixelLayout = nullptr ) const

protected

loadRegularPicture()

RegularPicture ph::RasterFileImage::loadRegularPicture

(

)

const

PH_DEFINE_SDL_CLASS()

ph::RasterFileImage::PH_DEFINE_SDL_CLASS ( TSdlOwnerClass< RasterFileImage > )

inline

setFilePath()

void ph::RasterFileImage::setFilePath

(

Path

filePath

)

---

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

• Source/Actor/Image/RasterFileImage.h
• Source/Actor/Image/RasterFileImage.cpp