HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
ImageSamplingProperties Class Reference

#include <ImageHandler.h>

Public Types

enum  AddressMode : int {
  AddressMode::UNSPECIFIED = -1, AddressMode::CONSTANT = 0, AddressMode::CLAMP = 1, AddressMode::PERIODIC = 2,
  AddressMode::MIRROR = 3
}
 
enum  FilterType : int { FilterType::UNSPECIFIED = -1, FilterType::CLOSEST = 0, FilterType::LINEAR = 1, FilterType::CUBIC = 2 }
 

Public Member Functions

void setProperties (const string &fileNameUniform, const VariableBlock &uniformBlock)
 
bool operator== (const ImageSamplingProperties &r) const
 

Public Attributes

AddressMode uaddressMode = AddressMode::UNSPECIFIED
 Address mode in U. More...
 
AddressMode vaddressMode = AddressMode::UNSPECIFIED
 Address mode in V. More...
 
FilterType filterType = FilterType::UNSPECIFIED
 Filter type. More...
 
bool enableMipmaps = true
 Enable mipmaps. More...
 
Color4 defaultColor = { 0.0f, 0.0f, 0.0f, 1.0f }
 

Detailed Description

Interface to describe sampling properties for images.

Definition at line 42 of file ImageHandler.h.

Member Enumeration Documentation

Address mode options. Matches enumerations allowed for image address modes, except UNSPECIFIED which indicates no explicit mode was defined.

Enumerator
UNSPECIFIED 
CONSTANT 
CLAMP 
PERIODIC 
MIRROR 

Definition at line 56 of file ImageHandler.h.

Filter type options. Matches enumerations allowed for image filter types, except UNSPECIFIED which indicates no explicit type was defined.

Enumerator
UNSPECIFIED 
CLOSEST 
LINEAR 
CUBIC 

Definition at line 72 of file ImageHandler.h.

Member Function Documentation

bool ImageSamplingProperties::operator== ( const ImageSamplingProperties r) const
void ImageSamplingProperties::setProperties ( const string fileNameUniform,
const VariableBlock uniformBlock 
)

Set the properties based on data in a uniform block.

Parameters
fileNameUniformName of the file name uniform. Used to find corresponding sampler data in the uniform block
uniformBlockBlock containing sampler uniforms

Member Data Documentation

Color4 ImageSamplingProperties::defaultColor = { 0.0f, 0.0f, 0.0f, 1.0f }

Default color. Corresponds to the "default" value on the image node definition.

Definition at line 88 of file ImageHandler.h.

bool ImageSamplingProperties::enableMipmaps = true

Enable mipmaps.

Definition at line 84 of file ImageHandler.h.

FilterType ImageSamplingProperties::filterType = FilterType::UNSPECIFIED

Filter type.

Definition at line 81 of file ImageHandler.h.

AddressMode ImageSamplingProperties::uaddressMode = AddressMode::UNSPECIFIED

Address mode in U.

Definition at line 66 of file ImageHandler.h.

AddressMode ImageSamplingProperties::vaddressMode = AddressMode::UNSPECIFIED

Address mode in V.

Definition at line 68 of file ImageHandler.h.


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