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

#include <ImfFlatImage.h>

+ Inheritance diagram for FlatImage:

Public Member Functions

IMFUTIL_EXPORT FlatImage ()
 
IMFUTIL_EXPORT FlatImage (const IMATH_NAMESPACE::Box2i &dataWindow, LevelMode levelMode=ONE_LEVEL, LevelRoundingMode levelRoundingMode=ROUND_DOWN)
 
virtual IMFUTIL_EXPORT ~FlatImage ()
 
virtual IMFUTIL_EXPORT
FlatImageLevel
level (int l=0)
 
virtual IMFUTIL_EXPORT const
FlatImageLevel
level (int l=0) const
 
virtual IMFUTIL_EXPORT
FlatImageLevel
level (int lx, int ly)
 
virtual IMFUTIL_EXPORT const
FlatImageLevel
level (int lx, int ly) const
 
- Public Member Functions inherited from Image
 ~Image ()
 
IMFUTIL_EXPORT Image ()
 
virtual IMFUTIL_EXPORT ~Image ()
 
IMFUTIL_EXPORT LevelMode levelMode () const
 
IMFUTIL_EXPORT LevelRoundingMode levelRoundingMode () const
 
IMFUTIL_EXPORT int numLevels () const
 
IMFUTIL_EXPORT int numXLevels () const
 
IMFUTIL_EXPORT int numYLevels () const
 
IMFUTIL_EXPORT const
IMATH_NAMESPACE::Box2i
dataWindow () const
 
IMFUTIL_EXPORT const
IMATH_NAMESPACE::Box2i
dataWindowForLevel (int l) const
 
IMFUTIL_EXPORT const
IMATH_NAMESPACE::Box2i
dataWindowForLevel (int lx, int ly) const
 
IMFUTIL_EXPORT int levelWidth (int lx) const
 
IMFUTIL_EXPORT int levelHeight (int ly) const
 
IMFUTIL_EXPORT void resize (const IMATH_NAMESPACE::Box2i &dataWindow)
 
virtual IMFUTIL_EXPORT void resize (const IMATH_NAMESPACE::Box2i &dataWindow, LevelMode levelMode, LevelRoundingMode levelRoundingMode)
 
IMFUTIL_EXPORT void shiftPixels (int dx, int dy)
 
IMFUTIL_EXPORT void insertChannel (const std::string &name, PixelType type, int xSampling=1, int ySampling=1, bool pLinear=false)
 
IMFUTIL_EXPORT void insertChannel (const std::string &name, const Channel &channel)
 
IMFUTIL_EXPORT void eraseChannel (const std::string &name)
 
IMFUTIL_EXPORT void clearChannels ()
 
IMFUTIL_EXPORT void renameChannel (const std::string &oldName, const std::string &newName)
 
IMFUTIL_EXPORT void renameChannels (const RenamingMap &oldToNewNames)
 
unsigned int getWidth () const
 Return the width of the image. More...
 
unsigned int getHeight () const
 Return the height of the image. More...
 
unsigned int getChannelCount () const
 Return the channel count of the image. More...
 
BaseType getBaseType () const
 Return the base type of the image. More...
 
unsigned int getBaseStride () const
 Return the stride of our base type in bytes. More...
 
unsigned int getRowStride () const
 Return the stride of an image row in bytes. More...
 
unsigned int getMaxMipCount () const
 Return the maximum number of mipmaps for this image. More...
 
void setTexelColor (unsigned int x, unsigned int y, const Color4 &color)
 
Color4 getTexelColor (unsigned int x, unsigned int y) const
 
Color4 getAverageColor ()
 Compute the average color of the image. More...
 
bool isUniformColor (Color4 *uniformColor=nullptr)
 
void setUniformColor (const Color4 &color)
 Set all texels of this image to a uniform color. More...
 
void applyMatrixTransform (const Matrix33 &mat)
 Apply the given matrix transform to all texels of this image. More...
 
void applyGammaTransform (float gamma)
 Apply the given gamma transform to all texels of this image. More...
 
ImagePtr copy (unsigned int channelCount, BaseType baseType) const
 Create a copy of this image with the given channel count and base type. More...
 
ImagePtr applyBoxBlur ()
 Apply a 3x3 box blur to this image, returning a new blurred image. More...
 
ImagePtr applyGaussianBlur ()
 Apply a 7x7 Gaussian blur to this image, returning a new blurred image. More...
 
ImagePair splitByLuminance (float luminance)
 
void writeTable (const FilePath &filePath, unsigned int channel)
 
void setResourceBuffer (void *buffer)
 Set the resource buffer for this image. More...
 
voidgetResourceBuffer () const
 Return the resource buffer for this image. More...
 
void createResourceBuffer ()
 Allocate a resource buffer for this image that matches its properties. More...
 
void releaseResourceBuffer ()
 Release the resource buffer for this image. More...
 
void setResourceBufferDeallocator (ImageBufferDeallocator deallocator)
 Set the resource buffer deallocator for this image. More...
 
ImageBufferDeallocator getResourceBufferDeallocator () const
 Return the resource buffer deallocator for this image. More...
 
void setResourceId (unsigned int id)
 Set the resource ID for this image. More...
 
unsigned int getResourceId () const
 Return the resource ID for this image. More...
 

Protected Member Functions

virtual IMFUTIL_EXPORT
FlatImageLevel
newLevel (int lx, int ly, const IMATH_NAMESPACE::Box2i &dataWindow)
 
- Protected Member Functions inherited from Image
 Image (unsigned int width, unsigned int height, unsigned int channelCount, BaseType baseType)
 

Additional Inherited Members

- Public Types inherited from Image
enum  BaseType { BaseType::UINT8 = 0, BaseType::UINT16 = 1, BaseType::HALF = 2, BaseType::FLOAT = 3 }
 
- Static Public Member Functions inherited from Image
static ImagePtr create (unsigned int width, unsigned int height, unsigned int channelCount, BaseType baseType=BaseType::UINT8)
 Create an empty image with the given properties. More...
 
- Protected Attributes inherited from Image
unsigned int _width
 
unsigned int _height
 
unsigned int _channelCount
 
BaseType _baseType
 
void_resourceBuffer
 
ImageBufferDeallocator _resourceBufferDeallocator
 
unsigned int _resourceId
 

Detailed Description

Definition at line 27 of file ImfFlatImage.h.

Constructor & Destructor Documentation

IMFUTIL_EXPORT FlatImage::FlatImage ( )
IMFUTIL_EXPORT FlatImage::FlatImage ( const IMATH_NAMESPACE::Box2i dataWindow,
LevelMode  levelMode = ONE_LEVEL,
LevelRoundingMode  levelRoundingMode = ROUND_DOWN 
)
virtual IMFUTIL_EXPORT FlatImage::~FlatImage ( )
virtual

Member Function Documentation

virtual IMFUTIL_EXPORT FlatImageLevel& FlatImage::level ( int  l = 0)
virtual

Reimplemented from Image.

virtual IMFUTIL_EXPORT const FlatImageLevel& FlatImage::level ( int  l = 0) const
virtual

Reimplemented from Image.

virtual IMFUTIL_EXPORT FlatImageLevel& FlatImage::level ( int  lx,
int  ly 
)
virtual

Reimplemented from Image.

virtual IMFUTIL_EXPORT const FlatImageLevel& FlatImage::level ( int  lx,
int  ly 
) const
virtual

Reimplemented from Image.

virtual IMFUTIL_EXPORT FlatImageLevel* FlatImage::newLevel ( int  lx,
int  ly,
const IMATH_NAMESPACE::Box2i dataWindow 
)
protectedvirtual

Implements Image.


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