#include <image.hpp>

Inheritance diagram for fcn::opengl::Image:

Public Member Functions
void	convertToDisplayFormat () override
void	free () override
int	getHeight () const override
Color	getPixel (int x, int y) override
virtual GLuint	getTextureHandle () const
virtual int	getTextureHeight () const
virtual int	getTextureWidth () const
int	getWidth () const override
	Image (GLuint textureHandle, int width, int height, bool autoFree)
	Image (std::span< unsigned int const > pixels, int width, int height, bool convertToDisplayFormat=true)
void	putPixel (int x, int y, Color const &color) override
Public Member Functions inherited from fcn::Image
	Image (Image &&)=delete
	Image (Image const &)=delete
Image &	operator= (Image &&)=delete
Image &	operator= (Image const &)=delete

Protected Attributes
bool	mAutoFree
int	mHeight
std::vector< unsigned int >	mPixels
GLuint	mTextureHandle
int	mTextureHeight
int	mTextureWidth
int	mWidth

Additional Inherited Members
Static Public Member Functions inherited from fcn::Image
static ImageLoader *	getImageLoader ()
static Image *	load (std::string const &filename, bool convertToDisplayFormat=true)
static void	resetImageLoader ()
static void	setImageLoader (ImageLoader *imageLoader)
Static Protected Attributes inherited from fcn::Image
static ImageLoader *	mImageLoader = nullptr

Detailed Description

OpenGL-specific implementation of Image.

Definition at line 37 of file backends/opengl/image.hpp.

Constructor & Destructor Documentation

◆ Image() [1/2]

fcn::opengl::Image::Image	(	std::span< unsigned int const >	pixels,
		int	width,
		int	height,
		bool	convertToDisplayFormat = true )

Constructor.

Loads an image from an array of pixels. The pixel array is is copied in the constructor and should thus be freed after the constructor has been called.

Note: The functions getPixel and putPixel are only guaranteed to work before an image has been converted to display format.

Parameters

pixels	pixel buffer to load from.
width	the width of the image.
height	the height of the image.
convertToDisplayFormat	true if the image should be converted to display, false otherwise.

Definition at line 16 of file backends/opengl/image.cpp.

References convertToDisplayFormat(), mAutoFree, mHeight, mPixels, mTextureHandle, mTextureHeight, mTextureWidth, and mWidth.

◆ Image() [2/2]

fcn::opengl::Image::Image	(	GLuint	textureHandle,
		int	width,
		int	height,
		bool	autoFree )

Constructor.

Load an image from an OpenGL texture handle. The width and height specifies the size of the "interesting" part of the texture, the real width and height of the texture are assumed to be the closest higher power of two.

Parameters

textureHandle	the texture handle from which to load.
width	the width of the image.
height	the height of the image.
autoFree	true if the surface should automatically be deleted.

Definition at line 57 of file backends/opengl/image.cpp.

References mAutoFree, mHeight, mPixels, mTextureHandle, mTextureHeight, mTextureWidth, and mWidth.

◆ ~Image()

fcn::opengl::Image::~Image ( )

overridevirtual

Reimplemented from fcn::Image.

Definition at line 76 of file backends/opengl/image.cpp.

Member Function Documentation

◆ convertToDisplayFormat()

void fcn::opengl::Image::convertToDisplayFormat ( )

overridevirtual

Converts the image, if possible, to display format.

IMPORTANT: Only guaranteed to work before the image has been converted to display format.

Implements fcn::Image.

Definition at line 167 of file backends/opengl/image.cpp.

References mPixels, mTextureHandle, mTextureHeight, mTextureWidth, and fcn::throwException().

Referenced by Image().

◆ free()

void fcn::opengl::Image::free ( )

overridevirtual

Frees an image.

Implements fcn::Image.

Definition at line 102 of file backends/opengl/image.cpp.

References mPixels, and mTextureHandle.

◆ getHeight()

int fcn::opengl::Image::getHeight ( ) const

overridevirtual

Gets the height of the image.

Returns: The height of the image.

Implements fcn::Image.

Definition at line 116 of file backends/opengl/image.cpp.

References mHeight.

◆ getPixel()

Color fcn::opengl::Image::getPixel	(	int	x,
		int	y )

overridevirtual

Gets the color of a pixel at coordinate (x, y) in the image.

IMPORTANT: Only guaranteed to work before the image has been converted to display format.

Parameters

x	The x coordinate.
y	The y coordinate.

Returns: The color of the pixel.

Implements fcn::Image.

Definition at line 121 of file backends/opengl/image.cpp.

References mHeight, mPixels, mTextureWidth, mWidth, and fcn::throwException().

◆ getTextureHandle()

GLuint fcn::opengl::Image::getTextureHandle ( ) const

virtual

Gets the OpenGL texture handle for the image.

Returns: the OpenGL texture handle for the image.

Definition at line 87 of file backends/opengl/image.cpp.

References mTextureHandle.

◆ getTextureHeight()

int fcn::opengl::Image::getTextureHeight ( ) const

virtual

Gets the height of the texture.

Returns: the height of the texture.

Definition at line 97 of file backends/opengl/image.cpp.

References mTextureHeight.

◆ getTextureWidth()

int fcn::opengl::Image::getTextureWidth ( ) const

virtual

Gets the width of texture.

Returns: the width of the texture.

Definition at line 92 of file backends/opengl/image.cpp.

References mTextureWidth.

◆ getWidth()

int fcn::opengl::Image::getWidth ( ) const

overridevirtual

Gets the width of the image.

Returns: The width of the image.

Implements fcn::Image.

Definition at line 111 of file backends/opengl/image.cpp.

References mWidth.

◆ putPixel()

void fcn::opengl::Image::putPixel	(	int	x,
		int	y,
		Color const &	color )

overridevirtual

Puts a pixel with a certain color at coordinate (x, y).

Parameters

x	The x coordinate.
y	The y coordinate.
color	The color of the pixel to put.

Implements fcn::Image.

Definition at line 148 of file backends/opengl/image.cpp.

References fcn::Color::a, fcn::Color::b, fcn::Color::g, mHeight, mPixels, mTextureWidth, mWidth, fcn::Color::r, and fcn::throwException().

Member Data Documentation

◆ mAutoFree

bool fcn::opengl::Image::mAutoFree

protected

Whether the texture handle should be freed on destruction.

Definition at line 116 of file backends/opengl/image.hpp.

Referenced by Image(), and Image().

◆ mHeight

int fcn::opengl::Image::mHeight

protected

Logical image height in pixels.

Definition at line 122 of file backends/opengl/image.hpp.

Referenced by getHeight(), getPixel(), Image(), Image(), and putPixel().

◆ mPixels

std::vector<unsigned int> fcn::opengl::Image::mPixels

protected

Pixel buffer copy for the image (RGBA packed).

Definition at line 113 of file backends/opengl/image.hpp.

Referenced by convertToDisplayFormat(), free(), getPixel(), Image(), Image(), and putPixel().

◆ mTextureHandle

GLuint fcn::opengl::Image::mTextureHandle

protected

OpenGL texture handle backing this image (if any).

Definition at line 110 of file backends/opengl/image.hpp.

Referenced by convertToDisplayFormat(), free(), getTextureHandle(), Image(), and Image().

◆ mTextureHeight

int fcn::opengl::Image::mTextureHeight

protected

Actual texture height (power-of-two) used by GL.

Definition at line 128 of file backends/opengl/image.hpp.

Referenced by convertToDisplayFormat(), getTextureHeight(), Image(), and Image().

◆ mTextureWidth

int fcn::opengl::Image::mTextureWidth

protected

Actual texture width (power-of-two) used by GL.

Definition at line 125 of file backends/opengl/image.hpp.

Referenced by convertToDisplayFormat(), getPixel(), getTextureWidth(), Image(), Image(), and putPixel().

◆ mWidth

int fcn::opengl::Image::mWidth

protected

Logical image width in pixels.

Definition at line 119 of file backends/opengl/image.hpp.

Referenced by getPixel(), getWidth(), Image(), Image(), and putPixel().

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Image() [1/2]

◆ Image() [2/2]

◆ ~Image()

Member Function Documentation

◆ convertToDisplayFormat()

◆ free()

◆ getHeight()

◆ getPixel()

◆ getTextureHandle()

◆ getTextureHeight()

◆ getTextureWidth()

◆ getWidth()

◆ putPixel()

Member Data Documentation

◆ mAutoFree

◆ mHeight

◆ mPixels

◆ mTextureHandle

◆ mTextureHeight

◆ mTextureWidth

◆ mWidth