draw::Image Class Reference

2D-array of pixels specified format. More...

#include <draw.h>

Public Types
enum	Format { Format::A, Format::RGB, Format::RGBA }
	A pixel format. More...
using	Bytes = Span< uint8_t >
	Sequence of bytes. More...

Public Member Functions
virtual	~Image ()=default
virtual const Size &	size () const =0
	return size More...
virtual Format	format () const =0
	return format More...
virtual bool	filter () const =0
	check if bilinear filtering is enabled or not More...
virtual void	upload (Bytes bytes)=0
	upload bytes to the image More...

Static Public Attributes
static const uint32_t	kMaxSize = 4096
	maximum available size of image's width and height More...

Detailed Description

2D-array of pixels specified format.

To create an object of this type use Renderer::makeImage function.

NOTE: exceptions are disabled. 'Exceptions' section lists expected errors which you can check via draw::getLastError.

Member Typedef Documentation

using draw::Image::Bytes = Span<uint8_t>

Sequence of bytes.

Member Enumeration Documentation

enum draw::Image::Format

strong

A pixel format.

Enumerator
A	1 byte per pixel (alpha only)
RGB	3 bytes per pixel (1-red, 1-green, 1-blue)
RGBA	4 bytes per pixel (1-red, 1-green, 1-blue, 1-alpha)

Constructor & Destructor Documentation

virtual draw::Image::~Image ( )

virtualdefault

Member Function Documentation

virtual bool draw::Image::filter ( ) const

pure virtual

check if bilinear filtering is enabled or not

virtual Format draw::Image::format ( ) const

pure virtual

return format

virtual const Size& draw::Image::size ( ) const

pure virtual

return size

virtual void draw::Image::upload ( Bytes  bytes )

pure virtual

upload bytes to the image

Exceptions

draw::InvalidArgument	if bytes.data is invalid
draw::InvalidArgument	if bytes.count != width * height * (bytes per pixel)

Member Data Documentation

const uint32_t draw::Image::kMaxSize = 4096

static

maximum available size of image's width and height

---

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

• src/draw.h