A 2D Image used to store 2D data, such as a normal map. More...

Inheritance diagram for cs237::DataImage2D:

[legend]

Collaboration diagram for cs237::DataImage2D:

[legend]

Public Member Functions
	DataImage2D (uint32_t wid, uint32_t ht, Channels chans, ChannelTy ty)

	DataImage2D (std::string const &file, bool flip=true)

	DataImage2D (std::ifstream &inS, bool flip=true)

Public Member Functions inherited from cs237::Image2D
	Image2D (uint32_t wid, uint32_t ht, Channels chans, ChannelTy ty)

	Image2D (std::string const &file, bool flip=true)

	Image2D (std::ifstream &inS, bool flip=true)

size_t	width () const
	return the width of the image

size_t	height () const
	return the height of the image

bool	write (const char *file, bool flip=true)

bool	write (std::ofstream &outS, bool flip=true)

void	bitblt (Image2D const &src, uint32_t row, uint32_t col)

Public Member Functions inherited from cs237::__detail::ImageBase
uint32_t	nDims () const
	the number of dimensions (1, 2, or 3)

Channels	channels () const
	return the format of the pixels.

ChannelTy	type () const
	returns the type of the channels

vk::Format	format () const
	return the vulkan format of the image data

void *	data () const
	the data pointer

size_t	nBytes () const
	the total number of bytes of image data

unsigned int	nChannels () const
	the number of channels (1, 2, 3, or 4)

size_t	nBytesPerPixel () const
	the number of bytes per pixel

void	addAlphaChannel ()

Additional Inherited Members
Protected Member Functions inherited from cs237::__detail::ImageBase
	ImageBase ()

	ImageBase (uint32_t nd)

	ImageBase (uint32_t nd, Channels chans, ChannelTy ty, size_t nPixels)

virtual	~ImageBase ()

Protected Attributes inherited from cs237::Image2D
uint32_t	_wid
	the width of the image in pixels

uint32_t	_ht
	the height of the image in pixels

Protected Attributes inherited from cs237::__detail::ImageBase
uint32_t	_nDims
	the number of dimensions (1 or 2)

Channels	_chans
	the texture format

ChannelTy	_type
	the representation type of the data

bool	_sRGB
	should the image be interpreted as an sRGB encoded image?

size_t	_nBytes
	size in bytes of image data

void *	_data
	the raw image data

Detailed Description

A 2D Image used to store 2D data, such as a normal map.

Constructor & Destructor Documentation

inline

create and allocate space for an uninitialized image

Parameters

inline

create and initialize an image from a PNG file.

Parameters

file	the name of the PNG file
flip	set to true if the image should be flipped vertically to match OpenGL texture coordinates (default true)

inline

create and initialize an image from a PNG-format input stream

Parameters

inS	the input stream
flip	set to true if the image should be flipped vertically to match OpenGL texture coordinates (default true)

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