#include <Image1.h>

Public Types
typedef Image1	Type

typedef shared_ptr< class Image1 >	Ref

typedef Color1	Storage

typedef Color1	Compute

Public Types inherited from G3D::Map2D< Color1, Color1 >
typedef Color1	StorageType

typedef Color1	ComputeType

typedef Map2D< Color1, Color1 >	Type

typedef shared_ptr< Map2D >	Ref

Public Member Functions
const class ImageFormat *	format () const

void	load (const std::string &filename)

void	save (const std::string &filename)

Public Member Functions inherited from G3D::Map2D< Color1, Color1 >
const Color1 &	fastGet (int x, int y) const

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

Color1	bicubic (float x, float y, WrapMode wrap) const

Color1	bicubic (float x, float y) const

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

Color1	bicubic (const Vector2 &p) const

void	resize (uint32 newW, uint32 newH)

bool	changed ()

void	setChanged (bool c)

Color1 *	getCArray ()

const Color1 *	getCArray () const

Array< Color1 > &	getArray ()

const Array< Color1 > &	getArray () const

bool	inBounds (int x, int y) const

bool	inBounds (const Vector2int16 &v) const

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

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)

void	set (const Vector2int16 &p, const Color1 &v)

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

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

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

void	setAll (const Color1 &v)

void	maybeFlipVertical (bool flip)

virtual void	flipVertical ()

virtual void	flipHorizontal ()

virtual void	crop (int newX, int newY, int newW, int newH)

virtual void	crop (const Rect2D &rect)

Color1	nearest (float x, float y, WrapMode wrap) const

Color1	nearest (float x, float y) const

Color1	nearest (const Vector2 &p) const

Color1	average () const

Color1	bilinear (float x, float y, WrapMode wrap) const

Color1	bilinear (float x, float y) const

Color1	bilinear (const Vector2 &p) const

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

int32	width () const

int32	height () const

Vector2int16	size () const

Rect2D	rect2DBounds () const

size_t	sizeInMemory () const

WrapMode	wrapMode () const

void	setWrapMode (WrapMode m)

Public Member Functions inherited from G3D::ReferenceCountedObject
virtual	~ReferenceCountedObject ()

Static Public Member Functions
static Ref	createEmpty (int width, int height, WrapMode wrap=WrapMode::ERROR)

static Ref	createEmpty (WrapMode wrap=WrapMode::ERROR)

static Ref	fromFile (const std::string &filename, WrapMode wrap=WrapMode::ERROR)

static Ref	fromArray (const class Color1unorm8 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static Ref	fromArray (const class Color3unorm8 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static Ref	fromArray (const class Color4unorm8 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static Ref	fromArray (const class Color1 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static Ref	fromArray (const class Color3 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

static Ref	fromArray (const class Color4 *ptr, int width, int height, WrapMode wrap=WrapMode::ERROR)

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

Static Public Member Functions inherited from G3D::Map2D< Color1, Color1 >
static Ref	create (int w=0, int h=0, WrapMode wrap=WrapMode::ERROR)

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

void	copyGImage (const class GImage &im)

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)

Protected Member Functions inherited from G3D::Map2D< Color1, Color1 >
const Color1 &	slowGet (int x, int y, WrapMode wrap)

Color1	bicubic (const Color1 *ctrl, double s) const

	Map2D (int w, int h, WrapMode wrap)

Additional Inherited Members
Public Attributes inherited from G3D::Map2D< Color1, Color1 >
GMutex	mutex

Protected Attributes inherited from G3D::Map2D< Color1, Color1 >
Color1	ZERO

uint32	w

uint32	h

WrapMode	_wrapMode

AtomicInt32	m_changed

Array< Color1 >	data

Detailed Description

Luminance image with 32-bit floating point storage.

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

Member Typedef Documentation

typedef Color1 G3D::Image1::Compute

typedef shared_ptr<class Image1> G3D::Image1::Ref

typedef Color1 G3D::Image1::Storage

typedef Image1 G3D::Image1::Type

Constructor & Destructor Documentation

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

protected

  : Map2D<Color1, Color1>(w, h, wrap) {
  setAll(Color1(0.0f));
 }

Here is the call graph for this function:

Member Function Documentation

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

protected

  {
  resize(w, h);
  System::memcpy(getCArray(), src, w * h * sizeof(Color1));
 }

Here is the call graph for this function:

Here is the caller graph for this function:

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

protected

  {
  resize(w, h);
  int N = w * h;
 
  Color1* dst = getCArray();
  for (int i = 0; i < N; ++i) {
  dst[i] = Color1(src[i].average());
  }
 }

Here is the call graph for this function:

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

protected

  {
  resize(w, h);
 
  int N = w * h;
  Color1* dst = data.getCArray();
  
  // Strip alpha
  for (int i = 0; i < N; ++i) {
  dst[i] = Color1(src[i].rgb().average());
  }
 }

Here is the call graph for this function:

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

protected

  {
  resize(w, h);
  int N = w * h;
 
  Color1* dst = getCArray();
  for (int i = 0; i < N; ++i) {
  dst[i]= Color1(src[i]);
  }
 }

Here is the call graph for this function:

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

protected

  {
  resize(w, h);
 
  int N = w * h;
  Color1* dst = data.getCArray();
  // Convert int8 -> float
  for (int i = 0; i < N; ++i) {
  dst[i] = Color1(Color3(src[i]).average());
  }
 }

Here is the call graph for this function:

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

protected

  {
  resize(w, h);
 
  int N = w * h;
  Color1* dst = data.getCArray();
  
  // Strip alpha and convert
  for (int i = 0; i < N; ++i) {
  dst[i] = Color1(Color3(src[i].rgb()).average());
  }
 }

Here is the call graph for this function:

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

protected

Image1::Ref G3D::Image1::createEmpty	(	int	width,
		int	height,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

Creates an all-zero width x height image.

  {
  return Image1::Ref(new Type(width, height, wrap));
 }

Here is the caller graph for this function:

Image1::Ref G3D::Image1::createEmpty ( WrapMode wrap = WrapMode::ERROR )

static

Creates a 0 x 0 image.

  {
  return createEmpty(0, 0, wrap);
 }

Here is the call graph for this function:

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

  {
  return ImageFormat::L32F();
 }

Here is the call graph for this function:

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

static

  {
  Ref out = createEmpty(wrap);
  out->copyArray(ptr, w, h);
  return out;
 }

Here is the call graph for this function:

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

static

  {
  Ref out = createEmpty(wrap);
  out->copyArray(ptr, w, h);
  return out;
 }

Here is the call graph for this function:

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

static

  {
  Ref out = createEmpty(wrap);
  out->copyArray(ptr, w, h);
  return out;
 }

Here is the call graph for this function:

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

static

  {
  Ref out = createEmpty(wrap);
  out->copyArray(ptr, w, h);
  return out;
 }

Here is the call graph for this function:

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

static

  {
  Ref out = createEmpty(wrap);
  out->copyArray(ptr, w, h);
  return out;
 }

Here is the call graph for this function:

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

static

  {
  Ref out = createEmpty(wrap);
  out->copyArray(ptr, w, h);
  return out;
 }

Here is the call graph for this function:

Image1::Ref G3D::Image1::fromFile	(	const std::string &	filename,
		WrapMode	wrap = `WrapMode::ERROR`
	)

static

  {
  Ref out = createEmpty(wrap);
  out->load(filename);
  return out;
 }

Here is the call graph for this function:

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

static

  {
  Ref out = createEmpty(static_cast<WrapMode>(im->wrapMode()));
  out->resize(im->width(), im->height());
 
  int N = im->width() * im->height();
  const Color1unorm8* src = reinterpret_cast<Color1unorm8*>(im->getCArray());
  for (int i = 0; i < N; ++i) {
  out->data[i] = Color1(src[i]);
  }
 
  return out;
 }

Here is the call graph for this function:

void G3D::Image1::load ( const std::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].

  {
  shared_ptr<Image> image = Image::fromFile(filename);
  if (image->format() != ImageFormat::L32F()) {
  image->convertToL8();
  }
 
  switch (image->format()->code)
  {
  case ImageFormat::CODE_L8:
  copyArray(static_cast<const Color1unorm8*>(image->toPixelTransferBuffer()->buffer()), image->width(), image->height());
  break;
  case ImageFormat::CODE_L32F:
  copyArray(static_cast<const Color1*>(image->toPixelTransferBuffer()->buffer()), image->width(), image->height());
  break;
  case ImageFormat::CODE_RGB8:
  copyArray(static_cast<const Color3unorm8*>(image->toPixelTransferBuffer()->buffer()), image->width(), image->height());
  break;
  case ImageFormat::CODE_RGB32F:
  copyArray(static_cast<const Color3*>(image->toPixelTransferBuffer()->buffer()), image->width(), image->height());
  break;
  case ImageFormat::CODE_RGBA8:
  copyArray(static_cast<const Color4unorm8*>(image->toPixelTransferBuffer()->buffer()), image->width(), image->height());
  break;
  case ImageFormat::CODE_RGBA32F:
  copyArray(static_cast<const Color4*>(image->toPixelTransferBuffer()->buffer()), image->width(), image->height());
  break;
  default:
  debugAssertM(false, "Trying to load unsupported image format");
  break;
  }
 
  setChanged(true);
 }

Here is the call graph for this function:

void G3D::Image1::save ( const std::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.

  {
  // To avoid saving as floating point image. FreeImage cannot convert floating point to L8.
  Image1unorm8::Ref unorm8 = Image1unorm8::fromImage1(dynamic_pointer_cast<Image1>(shared_from_this()));
  unorm8->save(filename);
 }

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

dep/g3dlite/include/G3D/Image1.h
dep/g3dlite/source/Image1.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation