Image.h File Reference

#include <MaterialXRender/Export.h>
#include <MaterialXFormat/File.h>
#include <MaterialXCore/Types.h>

Include dependency graph for Image.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	Image

Typedefs
using	ImagePtr = shared_ptr< Image >
	A shared pointer to an image. More...
using	ConstImagePtr = shared_ptr< const Image >
	A shared pointer to a const image. More...
using	ImageMap = std::unordered_map< string, ImagePtr >
	A map from strings to images. More...
using	ImageVec = std::vector< ImagePtr >
	A vector of images. More...
using	ImagePair = std::pair< ImagePtr, ImagePtr >
	A pair of images. More...
using	ImageBufferDeallocator = std::function< void(void *)>
	A function to perform image buffer deallocation. More...
using	UnsignedIntPair = std::pair< unsigned int, unsigned int >
	A pair of unsigned integers. More...

Functions
MX_RENDER_API ImagePtr	createUniformImage (unsigned int width, unsigned int height, unsigned int channelCount, Image::BaseType baseType, const Color4 &color)
	Create a uniform-color image with the given properties. More...
MX_RENDER_API ImagePtr	createImageStrip (const vector< ImagePtr > &imageVec)
	Create a horizontal image strip from a vector of images with identical resolutions and formats. More...
MX_RENDER_API UnsignedIntPair	getMaxDimensions (const vector< ImagePtr > &imageVec)
	Compute the maximum width and height of all images in the given vector. More...

Detailed Description

Image class

Definition in file Image.h.

Typedef Documentation

using ConstImagePtr = shared_ptr<const Image>

A shared pointer to a const image.

Definition at line 26 of file Image.h.

using ImageBufferDeallocator = std::function<void(void*)>

A function to perform image buffer deallocation.

Definition at line 38 of file Image.h.

using ImageMap = std::unordered_map<string, ImagePtr>

A map from strings to images.

Definition at line 29 of file Image.h.

using ImagePair = std::pair<ImagePtr, ImagePtr>

A pair of images.

Definition at line 35 of file Image.h.

using ImagePtr = shared_ptr<Image>

A shared pointer to an image.

Definition at line 23 of file Image.h.

using ImageVec = std::vector<ImagePtr>

A vector of images.

Definition at line 32 of file Image.h.

using UnsignedIntPair = std::pair<unsigned int, unsigned int>

A pair of unsigned integers.

Definition at line 41 of file Image.h.

Function Documentation

MX_RENDER_API ImagePtr createImageStrip

(

const vector< ImagePtr > &

imageVec

)

Create a horizontal image strip from a vector of images with identical resolutions and formats.

MX_RENDER_API ImagePtr createUniformImage	(	unsigned int	width,
		unsigned int	height,
		unsigned int	channelCount,
		Image::BaseType	baseType,
		const Color4 &	color
	)

Create a uniform-color image with the given properties.

MX_RENDER_API UnsignedIntPair getMaxDimensions

(

const vector< ImagePtr > &

imageVec

)

Compute the maximum width and height of all images in the given vector.