34#include "../../Core/Math/rect.h"
35#include "texture_format.h"
36#include "buffer_usage.h"
49 class PixelBuffer_Impl;
80 PixelBuffer(
int width,
int height,
TextureFormat texture_format,
const void *data =
nullptr,
bool only_reference_data =
false);
108 explicit operator bool()
const {
return bool(impl); }
155 template<
typename Type>
const Type *
get_data()
const {
return reinterpret_cast<Type*
>(
get_data()); }
302 std::shared_ptr<PixelBuffer_Impl> impl;
Color description class.
Definition color.h:46
Floating point color description class (for float).
Definition color.h:799
Virtual File System (VFS).
Definition file_system.h:47
Interface to drawing graphics.
Definition graphic_context.h:257
I/O Device interface.
Definition iodevice.h:50
Element Array Buffer provider.
Definition pixel_buffer_provider.h:42
Pixel data container.
Definition pixel_buffer.h:68
PixelBuffer(IODevice &file, const std::string &image_type, bool srgb=false)
Constructs a PixelBuffer.
const void * get_line(int line) const
Definition pixel_buffer.h:171
void premultiply_alpha()
Multiply the RGB components by the Alpha component.
PixelBufferProvider * get_provider() const
Get Provider.
Colorf get_pixel(int x, int y)
Return color of pixel at the specified coordinates.
float get_pixel_ratio() const
int get_height() const
Retrieves the actual height of the buffer.
PixelBuffer to_format(TextureFormat texture_format) const
Converts current buffer to a new pixel format and returns the result.
void * get_line(int line)
Returns a pointer to the beginning of a specific line.
Definition pixel_buffer.h:170
const Type * get_data() const
Definition pixel_buffer.h:155
void upload_data(GraphicContext &gc, const Rect &dest_rect, const void *data)
Uploads data to buffer.
static unsigned int get_data_size(const Size &size, TextureFormat texture_format)
Returns the size in bytes of the image data.
friend class PixelBuffer_Impl
Definition pixel_buffer.h:303
void unlock()
Unmaps element buffer.
unsigned int get_data_size() const
Returns the size in bytes of the image data.
unsigned int get_bytes_per_block() const
Returns the number of bytes per compression block.
bool has_transparency() const
Returns true if format has an alpha channel.
bool is_compressed() const
Returns true if compressed.
PixelBuffer(const std::string &filename, const FileSystem &file_system, bool srgb=false)
Constructs a PixelBuffer.
PixelBuffer copy() const
Create a copy of the pixelbuffer that doesn't share data with the original pixel buffer.
static unsigned int get_bytes_per_pixel(TextureFormat texture_format)
Returns the number of bytes per pixel.
unsigned short * get_line_uint16(int line)
Returns a pointer to the beginning of a specific line as 16 bit data.
Definition pixel_buffer.h:178
float get_dip_height() const
Returns the device independent height of this texture.
Definition pixel_buffer.h:141
static bool is_compressed(TextureFormat texture_format)
Returns true if compressed.
PixelBuffer(int width, int height, TextureFormat texture_format, const void *data=nullptr, bool only_reference_data=false)
Constructs a PixelBuffer.
bool is_null() const
Returns true if this object is invalid.
Definition pixel_buffer.h:107
static unsigned int get_bytes_per_block(TextureFormat texture_format)
Returns the number of bytes per compression block.
Type * get_data()
Definition pixel_buffer.h:154
Sizef get_dip_size() const
Returns the device independent size of this texture.
Definition pixel_buffer.h:144
PixelBuffer(std::unique_ptr< PixelBufferProvider > provider)
Constructs a PixelBuffer.
PixelBuffer to_gpu(GraphicContext &gc)
Uploads the pixel buffer to GPU memory.
PixelBuffer to_format(TextureFormat texture_format, PixelConverter &converter) const
Converts current buffer to a new pixel format and returns the result.
const void * get_data() const
void lock(GraphicContext &gc, BufferAccess access)
Maps buffer into system memory.
void set_subimage(const PixelBuffer &source, const Point &dest_pos, const Rect &src_rect, PixelConverter &converter)
Copy source pixel buffer into this buffer, doing a format conversion if needed.
const unsigned char * get_line_uint8(int line) const
Definition pixel_buffer.h:175
void set_image(const PixelBuffer &source)
Copy source pixel buffer into this buffer, doing a format conversion if needed.
void premultiply_gamma(float gamma)
Multiply the RGB components by gamma value.
const unsigned short * get_data_uint16() const
Definition pixel_buffer.h:163
void set_subimage(const PixelBuffer &source, const Point &dest_pos, const Rect &src_rect)
Copy source pixel buffer into this buffer, doing a format conversion if needed.
void set_image(const PixelBuffer &source, PixelConverter &converter)
Copy source pixel buffer into this buffer, doing a format conversion if needed.
const unsigned int * get_data_uint32() const
Definition pixel_buffer.h:167
PixelBuffer()
Constructs a null instance.
void set_pixel_ratio(float ratio)
Sets the display pixel ratio for this texture.
int get_width() const
Retrieves the actual width of the buffer.
PixelBuffer to_cpu(GraphicContext &gc)
Downloads the pixel buffer to CPU memory.
PixelBuffer copy(const Rect &rect) const
Create a copy of the pixelbuffer that doesn't share data with the original pixel buffer.
void flip_vertical()
Flip the entire image vertically (turn it upside down)
Size get_size() const
Retrieves the actual size of the buffer.
Definition pixel_buffer.h:126
unsigned int get_bytes_per_pixel() const
Returns the number of bytes per pixel.
const unsigned short * get_line_uint16(int line) const
Definition pixel_buffer.h:179
const unsigned char * get_data_uint8() const
Definition pixel_buffer.h:159
unsigned int * get_line_uint32(int line)
Returns a pointer to the beginning of a specific line as 32 bit data.
Definition pixel_buffer.h:182
const unsigned int * get_line_uint32(int line) const
Definition pixel_buffer.h:183
void * get_data()
Returns a pointer to the beginning of the pixel buffer.
bool is_gpu() const
Returns true if this pixel buffer is a GPU based one.
unsigned char * get_line_uint8(int line)
Returns a pointer to the beginning of a specific line as 8 bit data.
Definition pixel_buffer.h:174
PixelBuffer(const std::string &fullname, bool srgb=false)
Constructs a PixelBuffer.
float get_dip_width() const
Returns the device independent width of this texture.
Definition pixel_buffer.h:138
int get_pitch() const
Returns the pitch (in bytes per scanline).
unsigned short * get_data_uint16()
Returns a pointer to the beginning of the pixel buffer as 16 bit data.
Definition pixel_buffer.h:162
unsigned char * get_data_uint8()
Returns a pointer to the beginning of the pixel buffer as 8 bit data.
Definition pixel_buffer.h:158
unsigned int * get_data_uint32()
Returns a pointer to the beginning of the pixel buffer as 32 bit data.
Definition pixel_buffer.h:166
void throw_if_null() const
Throw an exception if this object is invalid.
TextureFormat get_format() const
Returns the pixel format.
Low level pixel format converter class.
Definition pixel_converter.h:45
2D (x,y) point structure - Integer
Definition point.h:62
2D (left,top,right,bottom) rectangle structure - Integer
Definition rect.h:446
2D (width,height) size structure - Integer
Definition size.h:176
2D (width,height) size structure - Float
Definition size.h:189
TextureFormat
Texture format.
Definition texture_format.h:39
BufferAccess
Array Buffer access enum.
Definition buffer_usage.h:53
PixelBufferDirection
Pixel buffer prefered direction.
Definition pixel_buffer.h:58
@ line
Definition graphic_context.h:79
@ data_to_gpu
Use of the pixel buffer is to send data to the gpu.
Definition pixel_buffer.h:60
@ data_from_gpu
Use of the pixel buffer is to retrieve data from the gpu.
Definition pixel_buffer.h:63