Luminance image with 32-bit floating point storage. More...

Inherits G3D::Map2D< Color1, Color1 >.

Public Types
typedef Color1	Compute

typedef Color1	ComputeType

typedef Color1	Storage

typedef Color1	StorageType

typedef Image1	Type

Public Member Functions
Color1	average () const
	Returns the average value of all elements of the map. More...

Color1	bicubic (float x, float y, WrapMode wrap) const
	Uses Catmull-Rom splines to interpolate between grid values. More...

Color1	bicubic (float x, float y) const

Color1	bicubic (const Vector2 &p, WrapMode wrap) const

Color1	bicubic (const Vector2 &p) const

Color1	bilinear (float x, float y, WrapMode wrap) const
	Needs to access elements from (floor(x), floor(y)) to (floor(x) + 1, floor(y) + 1) and will use the wrap mode appropriately (possibly generating out of bounds errors). More...

Color1	bilinear (float x, float y) const

Color1	bilinear (const Vector2 &p) const

Color1	bilinear (const Vector2 &p, WrapMode wrap) const

bool	changed ()
	Returns true if this map has been written to since the last call to setChanged(false). More...

virtual void	crop (int newX, int newY, int newW, int newH)
	Crops this map so that it only contains pixels between (x, y) and (x + w - 1, y + h - 1) inclusive. More...

virtual void	crop (const Rect2D &rect)
	iRounds to the nearest x0 and y0. More...

const Color1 &	fastGet (int x, int y) const
	Unsafe access to the underlying data structure with no wrapping support; requires that (x, y) is in bounds. More...

void	fastSet (int x, int y, const Color1 &v)
	Unsafe access to the underlying data structure with no wrapping support; requires that (x, y) is in bounds. More...

virtual void	flipHorizontal ()

virtual void	flipVertical ()

const class ImageFormat *	format () const

const Color1 &	get (int x, int y, WrapMode wrap) const
	Get the value at (x, y). More...

const Color1 &	get (int x, int y) const

const Color1 &	get (const Vector2int16 &p) const

const Color1 &	get (const Vector2int16 &p, WrapMode wrap) const

Color1 &	get (int x, int y, WrapMode wrap)

Color1 &	get (int x, int y)

Color1 &	get (const Vector2int16 &p)

Array< Color1 > &	getArray ()
	Row-major array. More...

const Array< Color1 > &	getArray () const

Color1 *	getCArray ()
	Returns a pointer to the underlying row-major data. More...

const Color1 *	getCArray () const

int32	height () const
	Pixel height. More...

bool	inBounds (int x, int y) const
	is (x, y) strictly within the image bounds, or will it trigger some kind of wrap mode More...

bool	inBounds (const Vector2int16 &v) const
	is (x, y) strictly within the image bounds, or will it trigger some kind of wrap mode More...

void	load (const String &filename)
	Loads from any of the file formats supported by G3D::Image. More...

void	maybeFlipVertical (bool flip)
	flips if flip is true More...

Color1	nearest (float x, float y, WrapMode wrap) const
	Returns the nearest neighbor. More...

Color1	nearest (float x, float y) const

Color1	nearest (const Vector2 &p) const

Rect2D	rect2DBounds () const
	Rectangle from (0, 0) to (w, h) More...

void	resize (uint32 newW, uint32 newH, uint32 newD=1)
	Resizes without clearing, leaving garbage. More...

void	save (const String &filename)
	Saves in any of the formats supported by G3D::Image. More...

void	set (const Vector2int16 &p, const Color1 &v)
	Sets the changed flag to true. More...

void	set (int x, int y, const Color1 &v, WrapMode wrap)
	Sets the changed flag to true. More...

void	set (int x, int y, const Color1 &v)

void	set (const shared_ptr< Map2D< Color1, T > > &src)
	Copy values from src, which must have the same size. More...

void	setAll (const Color1 &v)

void	setChanged (bool c)
	Set/unset the changed flag. More...

void	setWrapMode (WrapMode m)

Vector2int16	size () const
	Dimensions in pixels. More...

size_t	sizeInMemory () const
	Number of bytes occupied by the image data and this structure. More...

int32	width () const
	Pixel width. More...

WrapMode	wrapMode () const

Static Public Member Functions
static shared_ptr< Map2D< Color1, Color1 > >	create (int w=0, int h=0, WrapMode wrap=WrapMode::ERROR, int d=1)

static shared_ptr< Image1 >	createEmpty (int width, int height, WrapMode wrap=WrapMode::ERROR)
	Creates an all-zero width x height image. More...

static shared_ptr< Image1 >	createEmpty (WrapMode wrap=WrapMode::ERROR)
	Creates a 0 x 0 image. More...

static shared_ptr< Image1 >	fromArray (const class Color1unorm8 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static shared_ptr< Image1 >	fromArray (const class Color3unorm8 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static shared_ptr< Image1 >	fromArray (const class Color4unorm8 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static shared_ptr< Image1 >	fromArray (const class Color1 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static shared_ptr< Image1 >	fromArray (const class Color3 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static shared_ptr< Image1 >	fromArray (const class Color4 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static shared_ptr< Image1 >	fromFile (const String &filename, WrapMode wrap=WrapMode::ERROR)

static shared_ptr< Image1 >	fromImage1unorm8 (const shared_ptr< class Image1unorm8 > &im)

static float	R (float x)

Public Attributes
std::mutex	mutex
	Although Map2D is not threadsafe (except for the setChanged() method), you can use this mutex to create your own threadsafe access to a Map2D. More...

Protected Member Functions
	Image1 (int w, int h, WrapMode wrap)

void	copyArray (const Color1 *src, int w, int h)

void	copyArray (const Color3 *src, int w, int h)

void	copyArray (const Color4 *src, int w, int h)

void	copyArray (const Color1unorm8 *src, int w, int h)

void	copyArray (const Color3unorm8 *src, int w, int h)

void	copyArray (const Color4unorm8 *src, int w, int h)

void	copyGImage (const class GImage &im)

const Color1 &	slowGet (int x, int y, WrapMode wrap)
	Handles the exceptional cases from get. More...

Static Protected Member Functions
template<class T , class ... ArgTypes>
static shared_ptr< T >	createShared (ArgTypes &&... args)
	Like std::make_shared, but works for protected constructors. More...

Protected Attributes
uint32	d
	Depth, in pixels, defaults to 1. More...

Array< Color1 >	data

uint32	h
	Height, in pixels. More...

std::atomic_bool	m_changed
	false if no mutating method has been invoked since the last call to setChanged(); More...

WrapMode	m_wrapMode

uint32	w
	Width, in pixels. More...

Color1	ZERO

Detailed Description

Luminance image with 32-bit floating point storage.

See also G3D::Image1unorm8, G3D::GImage.

Member Typedef Documentation

◆ Compute

typedef Color1 G3D::Image1::Compute

◆ ComputeType

typedef Color1 G3D::Map2D< Color1 , Color1 >::ComputeType

inherited

◆ Storage

typedef Color1 G3D::Image1::Storage

◆ StorageType

typedef Color1 G3D::Map2D< Color1 , Color1 >::StorageType

inherited

◆ Type

typedef Image1 G3D::Image1::Type

Constructor & Destructor Documentation

◆ Image1()

G3D::Image1::Image1	(	int	w,
		int	h,
		WrapMode	wrap
	)

protected

Member Function Documentation

◆ average()

Color1 G3D::Map2D< Color1 , Color1 >::average ( ) const

inlineinherited

Returns the average value of all elements of the map.

◆ bicubic() [1/4]

Color1 G3D::Map2D< Color1 , Color1 >::bicubic	(	float	x,
		float	y,
		WrapMode	wrap
	)		const

inlineinherited

Uses Catmull-Rom splines to interpolate between grid values.

◆ bicubic() [2/4]

Color1 G3D::Map2D< Color1 , Color1 >::bicubic	(	float	x,
		float	y
	)		const

inlineinherited

◆ bicubic() [3/4]

Color1 G3D::Map2D< Color1 , Color1 >::bicubic	(	const Vector2 &	p,
		WrapMode	wrap
	)		const

inlineinherited

◆ bicubic() [4/4]

Color1 G3D::Map2D< Color1 , Color1 >::bicubic ( const Vector2 & p ) const

inlineinherited

◆ bilinear() [1/4]

Color1 G3D::Map2D< Color1 , Color1 >::bilinear	(	float	x,
		float	y,
		WrapMode	wrap
	)		const

inlineinherited

Needs to access elements from (floor(x), floor(y)) to (floor(x) + 1, floor(y) + 1) and will use the wrap mode appropriately (possibly generating out of bounds errors).

Guaranteed to match nearest(x, y) at integers.

◆ bilinear() [2/4]

Color1 G3D::Map2D< Color1 , Color1 >::bilinear	(	float	x,
		float	y
	)		const

inlineinherited

◆ bilinear() [3/4]

Color1 G3D::Map2D< Color1 , Color1 >::bilinear ( const Vector2 & p ) const

inlineinherited

◆ bilinear() [4/4]

Color1 G3D::Map2D< Color1 , Color1 >::bilinear	(	const Vector2 &	p,
		WrapMode	wrap
	)		const

inlineinherited

◆ changed()

bool G3D::Map2D< Color1 , Color1 >::changed ( )

inlineinherited

Returns true if this map has been written to since the last call to setChanged(false).

This is useful if you are caching a texture map other value that must be recomputed whenever this changes.

◆ copyArray() [1/6]

void G3D::Image1::copyArray	(	const Color1 *	src,
		int	w,
		int	h
	)

protected

◆ copyArray() [2/6]

void G3D::Image1::copyArray	(	const Color3 *	src,
		int	w,
		int	h
	)

protected

◆ copyArray() [3/6]

void G3D::Image1::copyArray	(	const Color4 *	src,
		int	w,
		int	h
	)

protected

◆ copyArray() [4/6]

void G3D::Image1::copyArray	(	const Color1unorm8 *	src,
		int	w,
		int	h
	)

protected

◆ copyArray() [5/6]

void G3D::Image1::copyArray	(	const Color3unorm8 *	src,
		int	w,
		int	h
	)

protected

◆ copyArray() [6/6]

void G3D::Image1::copyArray	(	const Color4unorm8 *	src,
		int	w,
		int	h
	)

protected

◆ copyGImage()

void G3D::Image1::copyGImage ( const class GImage & im )

protected

◆ create()

static shared_ptr< Map2D<Color1 , Color1 > > G3D::Map2D< Color1 , Color1 >::create	(	int	w = `0`,
		int	h = `0`,
		WrapMode	wrap = `WrapMode::ERROR`,
		int	d = `1`
	)

inlinestaticinherited

◆ createEmpty() [1/2]

static shared_ptr<Image1> G3D::Image1::createEmpty	(	int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

Creates an all-zero width x height image.

◆ createEmpty() [2/2]

static shared_ptr<Image1> G3D::Image1::createEmpty ( WrapMode wrap = WrapMode::ERROR )

static

Creates a 0 x 0 image.

◆ createShared()

template<class T , class ... ArgTypes>

static shared_ptr<T> G3D::ReferenceCountedObject::createShared ( ArgTypes &&... args )

inlinestaticprotectedinherited

Like std::make_shared, but works for protected constructors.

Call as createShared<myclass>.

◆ crop() [1/2]

virtual void G3D::Map2D< Color1 , Color1 >::crop	(	int	newX,
		int	newY,
		int	newW,
		int	newH
	)

inlinevirtualinherited

Crops this map so that it only contains pixels between (x, y) and (x + w - 1, y + h - 1) inclusive.

◆ crop() [2/2]

virtual void G3D::Map2D< Color1 , Color1 >::crop ( const Rect2D & rect )

inlinevirtualinherited

iRounds to the nearest x0 and y0.

◆ fastGet()

const Color1 & G3D::Map2D< Color1 , Color1 >::fastGet	(	int	x,
		int	y
	)		const

inlineinherited

Unsafe access to the underlying data structure with no wrapping support; requires that (x, y) is in bounds.

◆ fastSet()

void G3D::Map2D< Color1 , Color1 >::fastSet	(	int	x,
		int	y,
		const Color1 &	v
	)

inlineinherited

Unsafe access to the underlying data structure with no wrapping support; requires that (x, y) is in bounds.

◆ flipHorizontal()

virtual void G3D::Map2D< Color1 , Color1 >::flipHorizontal ( )

inlinevirtualinherited

◆ flipVertical()

virtual void G3D::Map2D< Color1 , Color1 >::flipVertical ( )

inlinevirtualinherited

◆ format()

const class ImageFormat* G3D::Image1::format ( ) const

◆ fromArray() [1/6]

static shared_ptr<Image1> G3D::Image1::fromArray	(	const class Color1unorm8 *	ptr,
		int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

◆ fromArray() [2/6]

static shared_ptr<Image1> G3D::Image1::fromArray	(	const class Color3unorm8 *	ptr,
		int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

◆ fromArray() [3/6]

static shared_ptr<Image1> G3D::Image1::fromArray	(	const class Color4unorm8 *	ptr,
		int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

◆ fromArray() [4/6]

static shared_ptr<Image1> G3D::Image1::fromArray	(	const class Color1 *	ptr,
		int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

◆ fromArray() [5/6]

static shared_ptr<Image1> G3D::Image1::fromArray	(	const class Color3 *	ptr,
		int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

◆ fromArray() [6/6]

static shared_ptr<Image1> G3D::Image1::fromArray	(	const class Color4 *	ptr,
		int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

◆ fromFile()

static shared_ptr<Image1> G3D::Image1::fromFile	(	const String &	filename,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

◆ fromImage1unorm8()

static shared_ptr<Image1> G3D::Image1::fromImage1unorm8 ( const shared_ptr< class Image1unorm8 > & im )

static

◆ get() [1/7]

const Color1 & G3D::Map2D< Color1 , Color1 >::get	(	int	x,
		int	y,
		WrapMode	wrap
	)		const

inlineinherited

Get the value at (x, y).

Note that the type of image->get(x, y) is the storage type, not the computation type. If the constructor promoting Storage to Compute rescales values (as, for example Color3(Color3uint8&) does), this will not match the value returned by Map2D::nearest.

◆ get() [2/7]

const Color1 & G3D::Map2D< Color1 , Color1 >::get	(	int	x,
		int	y
	)		const

inlineinherited

◆ get() [3/7]

const Color1 & G3D::Map2D< Color1 , Color1 >::get ( const Vector2int16 & p ) const

inlineinherited

◆ get() [4/7]

const Color1 & G3D::Map2D< Color1 , Color1 >::get	(	const Vector2int16 &	p,
		WrapMode	wrap
	)		const

inlineinherited

◆ get() [5/7]

Color1 & G3D::Map2D< Color1 , Color1 >::get	(	int	x,
		int	y,
		WrapMode	wrap
	)

inlineinherited

◆ get() [6/7]

Color1 & G3D::Map2D< Color1 , Color1 >::get	(	int	x,
		int	y
	)

inlineinherited

◆ get() [7/7]

Color1 & G3D::Map2D< Color1 , Color1 >::get ( const Vector2int16 & p )

inlineinherited

◆ getArray() [1/2]

Array<Color1 >& G3D::Map2D< Color1 , Color1 >::getArray ( )

inlineinherited

Row-major array.

You should call setChanged(true) if you mutate the array.

◆ getArray() [2/2]

const Array<Color1 >& G3D::Map2D< Color1 , Color1 >::getArray ( ) const

inlineinherited

◆ getCArray() [1/2]

Color1 * G3D::Map2D< Color1 , Color1 >::getCArray ( )

inlineinherited

Returns a pointer to the underlying row-major data.

There is no padding at the end of the row. Be careful–this will be reallocated during a resize. You should call setChanged(true) if you mutate the array.

◆ getCArray() [2/2]

const Color1 * G3D::Map2D< Color1 , Color1 >::getCArray ( ) const

inlineinherited

◆ height()

int32 G3D::Map2D< Color1 , Color1 >::height ( ) const

inlineinherited

Pixel height.

◆ inBounds() [1/2]

bool G3D::Map2D< Color1 , Color1 >::inBounds	(	int	x,
		int	y
	)		const

inlineinherited

is (x, y) strictly within the image bounds, or will it trigger some kind of wrap mode

◆ inBounds() [2/2]

bool G3D::Map2D< Color1 , Color1 >::inBounds ( const Vector2int16 & v ) const

inlineinherited

is (x, y) strictly within the image bounds, or will it trigger some kind of wrap mode

◆ load()

void G3D::Image1::load ( const String & filename )

Loads from any of the file formats supported by G3D::Image.

If there is an alpha channel on the input, it is stripped. Values are automatically scaled to the range [0, 1].

◆ maybeFlipVertical()

void G3D::Map2D< Color1 , Color1 >::maybeFlipVertical ( bool flip )

inlineinherited

flips if flip is true

◆ nearest() [1/3]

Color1 G3D::Map2D< Color1 , Color1 >::nearest	(	float	x,
		float	y,
		WrapMode	wrap
	)		const

inlineinherited

Returns the nearest neighbor.

Pixel values are considered to be at the upper left corner, so image->nearest(x, y) == image(x, y)

◆ nearest() [2/3]

Color1 G3D::Map2D< Color1 , Color1 >::nearest	(	float	x,
		float	y
	)		const

inlineinherited

◆ nearest() [3/3]

Color1 G3D::Map2D< Color1 , Color1 >::nearest ( const Vector2 & p ) const

inlineinherited

◆ R()

static float G3D::Map2D< Color1 , Color1 >::R ( float x )

inlinestaticinherited

◆ rect2DBounds()

Rect2D G3D::Map2D< Color1 , Color1 >::rect2DBounds ( ) const

inlineinherited

Rectangle from (0, 0) to (w, h)

◆ resize()

void G3D::Map2D< Color1 , Color1 >::resize	(	uint32	newW,
		uint32	newH,
		uint32	newD = `1`
	)

inlineinherited

Resizes without clearing, leaving garbage.

◆ save()

void G3D::Image1::save ( const String & filename )

Saves in any of the formats supported by G3D::Image.

The data values are assumed to be on the range [0, 1] and will be scaled appropriately for the save format.

◆ set() [1/4]

void G3D::Map2D< Color1 , Color1 >::set	(	const Vector2int16 &	p,
		const Color1 &	v
	)

inlineinherited

Sets the changed flag to true.

◆ set() [2/4]

void G3D::Map2D< Color1 , Color1 >::set	(	int	x,
		int	y,
		const Color1 &	v,
		WrapMode	wrap
	)

inlineinherited

Sets the changed flag to true.

◆ set() [3/4]

void G3D::Map2D< Color1 , Color1 >::set	(	int	x,
		int	y,
		const Color1 &	v
	)

inlineinherited

◆ set() [4/4]

void G3D::Map2D< Color1 , Color1 >::set ( const shared_ptr< Map2D< Color1 , T > > & src )

inlineinherited

Copy values from src, which must have the same size.

◆ setAll()

void G3D::Map2D< Color1 , Color1 >::setAll ( const Color1 & v )

inlineinherited

◆ setChanged()

void G3D::Map2D< Color1 , Color1 >::setChanged ( bool c )

inlineinherited

Set/unset the changed flag.

◆ setWrapMode()

void G3D::Map2D< Color1 , Color1 >::setWrapMode ( WrapMode m )

inlineinherited

◆ size()

Vector2int16 G3D::Map2D< Color1 , Color1 >::size ( ) const

inlineinherited

Dimensions in pixels.

◆ sizeInMemory()

size_t G3D::Map2D< Color1 , Color1 >::sizeInMemory ( ) const

inlineinherited

Number of bytes occupied by the image data and this structure.

◆ slowGet()

const Color1 & G3D::Map2D< Color1 , Color1 >::slowGet	(	int	x,
		int	y,
		WrapMode	wrap
	)

inlineprotectedinherited

Handles the exceptional cases from get.

◆ width()

int32 G3D::Map2D< Color1 , Color1 >::width ( ) const

inlineinherited

Pixel width.

◆ wrapMode()

WrapMode G3D::Map2D< Color1 , Color1 >::wrapMode ( ) const

inlineinherited

Member Data Documentation

◆ d

uint32 G3D::Map2D< Color1 , Color1 >::d

protectedinherited

Depth, in pixels, defaults to 1.

◆ data

Array<Color1 > G3D::Map2D< Color1 , Color1 >::data

protectedinherited

◆ h

uint32 G3D::Map2D< Color1 , Color1 >::h

protectedinherited

Height, in pixels.

◆ m_changed

std::atomic_bool G3D::Map2D< Color1 , Color1 >::m_changed

protectedinherited

false if no mutating method has been invoked since the last call to setChanged();

◆ m_wrapMode

WrapMode G3D::Map2D< Color1 , Color1 >::m_wrapMode

protectedinherited

◆ mutex

std::mutex G3D::Map2D< Color1 , Color1 >::mutex

inherited

Although Map2D is not threadsafe (except for the setChanged() method), you can use this mutex to create your own threadsafe access to a Map2D.

Not used by the default implementation.

◆ w

uint32 G3D::Map2D< Color1 , Color1 >::w

protectedinherited

Width, in pixels.

◆ ZERO

Color1 G3D::Map2D< Color1 , Color1 >::ZERO

protectedinherited

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Compute

◆ ComputeType

◆ Storage

◆ StorageType

◆ Type

Constructor & Destructor Documentation

◆ Image1()

Member Function Documentation

◆ average()

◆ bicubic() [1/4]

◆ bicubic() [2/4]

◆ bicubic() [3/4]

◆ bicubic() [4/4]

◆ bilinear() [1/4]

◆ bilinear() [2/4]

◆ bilinear() [3/4]

◆ bilinear() [4/4]

◆ changed()

◆ copyArray() [1/6]

◆ copyArray() [2/6]

◆ copyArray() [3/6]

◆ copyArray() [4/6]

◆ copyArray() [5/6]

◆ copyArray() [6/6]

◆ copyGImage()

◆ create()

◆ createEmpty() [1/2]

◆ createEmpty() [2/2]

◆ createShared()

◆ crop() [1/2]

◆ crop() [2/2]

◆ fastGet()

◆ fastSet()

◆ flipHorizontal()

◆ flipVertical()

◆ format()

◆ fromArray() [1/6]

◆ fromArray() [2/6]

◆ fromArray() [3/6]

◆ fromArray() [4/6]

◆ fromArray() [5/6]

◆ fromArray() [6/6]

◆ fromFile()

◆ fromImage1unorm8()

◆ get() [1/7]

◆ get() [2/7]

◆ get() [3/7]

◆ get() [4/7]

◆ get() [5/7]

◆ get() [6/7]

◆ get() [7/7]

◆ getArray() [1/2]

◆ getArray() [2/2]

◆ getCArray() [1/2]

◆ getCArray() [2/2]

◆ height()

◆ inBounds() [1/2]

◆ inBounds() [2/2]

◆ load()

◆ maybeFlipVertical()

◆ nearest() [1/3]

◆ nearest() [2/3]

◆ nearest() [3/3]

◆ R()

◆ rect2DBounds()

◆ resize()

◆ save()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]