Image functions and defintions. More...

#include "gfx/legato/common/legato_common.h"
#include "gfx/legato/common/legato_color.h"
#include "gfx/legato/common/legato_pixelbuffer.h"
#include "gfx/legato/core/legato_stream.h"

Include dependency graph for legato_image.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	leImageMap
	This struct represents an image map. More...

struct	leImage

struct	leImageDecoder
	This struct represents an image decoder. More...

Macros
#define	LE_IMAGE_FORMAT_COUNT (LE_IMAGE_FORMAT_RLE + 1)

Typedefs
typedef struct lePalette	lePalette

typedef enum leImageFormat	leImageFormat
	This enum represents an image format. More...

typedef enum leImageFlags	leImageFlags
	This enum represents image flags. More...

typedef enum leImageFilterMode	leImageFilterMode
	This enum represents image filter modes. More...

typedef struct leImageMap	leImageMap
	This struct represents an image map. More...

typedef struct leImage	leImage

typedef struct leImageDecoder	leImageDecoder
	This struct represents an image decoder. More...

Enumerations
enum	leImageFormat { LE_IMAGE_FORMAT_RAW = 0, LE_IMAGE_FORMAT_RLE, LE_IMAGE_FORMAT_JPEG, LE_IMAGE_FORMAT_PNG, LE_IMAGE_FORMAT_MONO }
	This enum represents an image format. More...

enum	leImageFlags { LE_IMAGE_USE_MASK_COLOR = 1 << 0, LE_IMAGE_USE_MASK_MAP = 1 << 1, LE_IMAGE_USE_ALPHA_MAP = 1 << 2, LE_IMAGE_INTERNAL_ALLOC = 1 << 3, LE_IMAGE_DIRECT_BLIT = 1 << 4 }
	This enum represents image flags. More...

enum	leImageFilterMode { LE_IMAGEFILTER_NONE, LE_IMAGEFILTER_NEAREST_NEIGHBOR, LE_IMAGEFILTER_BILINEAR }
	This enum represents image filter modes. More...

Functions
leResult	leImage_Create (leImage img, uint32_t width, uint32_t height, leColorMode mode, void data, uint32_t locationID)
	Create an image. More...

leImage *	leImage_Allocate (uint32_t width, uint32_t height, leColorMode mode)
	Allocate an image buffer. More...

leResult	leImage_Free (leImage *img)
	Free image buffer. More...

void	leImage_InitDecoders (void)
	Get Event Count. More...

leResult	leImage_Draw (const leImage img, const leRect sourceRect, int32_t x, int32_t y, uint32_t a)
	Draw an Image. More...

leResult	leImage_Resize (const leImage src, const leRect sourceRect, leImageFilterMode mode, uint32_t sizeX, uint32_t sizeY, leImage *target)
	Resize image. More...

leResult	leImage_ResizeDraw (const leImage src, const leRect sourceRect, leImageFilterMode mode, uint32_t sizeX, uint32_t sizeY, int32_t x, int32_t y, uint32_t a)
	Resize draw image. More...

leResult	leImage_Copy (const leImage src, const leRect sourceRect, int32_t x, int32_t y, leImage *dst)
	Copy image. More...

leResult	leImage_Render (const leImage src, const leRect sourceRect, int32_t x, int32_t y, leBool ignoreMask, leBool ignoreAlpha, leImage *dst)
	Render image. More...

leResult	leImage_Rotate (const leImage src, const leRect sourceRect, leImageFilterMode mode, int32_t angle, leImage **dst, leBool alloc)
	Rotate image. More...

leResult	leImage_RotateDraw (const leImage src, const leRect sourceRect, leImageFilterMode mode, int32_t angle, int32_t x, int32_t y, uint32_t a)
	Rotate draw image. More...

void	leProcessImage (leImage *img, size_t addr, leColorMode mode)
	Process an image to another location. More...

Detailed Description

Image functions and defintions.

Image drawing at specified coordinates.

Typedef Documentation

◆ leImageDecoder

typedef struct leImageDecoder leImageDecoder

This struct represents an image decoder.

Structure defining a general image decoder object. Specific decoders will implement this in their own way.

◆ leImageFilterMode

typedef enum leImageFilterMode leImageFilterMode

This enum represents image filter modes.

Image filter modes are used to list supported image filters.

◆ leImageFlags

typedef enum leImageFlags leImageFlags

This enum represents image flags.

Image flags are used to describe an image asset.

◆ leImageFormat

typedef enum leImageFormat leImageFormat

This enum represents an image format.

Image format is used to list supported image encodings.

◆ leImageMap

typedef struct leImageMap leImageMap

This struct represents an image map.

An image map is used to describe an image map buffer.

Enumeration Type Documentation

◆ leImageFilterMode

enum leImageFilterMode

This enum represents image filter modes.

Image filter modes are used to list supported image filters.

◆ leImageFlags

enum leImageFlags

This enum represents image flags.

Image flags are used to describe an image asset.

◆ leImageFormat

enum leImageFormat

This enum represents an image format.

Image format is used to list supported image encodings.

Function Documentation

◆ leImage_Allocate()

leImage* leImage_Allocate	(	uint32_t	width,
		uint32_t	height,
		leColorMode	mode
	)

Allocate an image buffer.

Dynamically allocates an image buffer in local memory using width and height color mode mode.

uint32_t width;
uint32_t height;
leColorMode mode;
leImage* img = leImage_Allocate();

Parameters

width	the width of the image in pixels
height	the height of the image in pixels
mode	the color mode of the image

Returns: a valid image or null if there wasn't enough memory for the allocation

◆ leImage_Copy()

leResult leImage_Copy	(	const leImage *	src,
		const leRect *	sourceRect,
		int32_t	x,
		int32_t	y,
		leImage *	dst
	)

Copy image.

Copies img bounded by srcRect to location x and y.

leImage* src;
leRect* sourceRect;
int32_t x;
int32_t y;
leImage* dst;
leResult res = leImage_Copy(src, sourceRect, x, y, dst);

Parameters

src	pointer to source image asset to draw
sourceRect	the source rectangle of the image to decode
x	the x position
y	the y position
dst	the destination image to fill

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leImage_Create()

leResult leImage_Create	(	leImage *	img,
		uint32_t	width,
		uint32_t	height,
		leColorMode	mode,
		void *	data,
		uint32_t	locationID
	)

Create an image.

Creates an image img given width, height, and mode. The image is located at data with locationID.

leResult res = leImage_Create();

Parameters

img	the image object to initialize
width	the width of the image
height	the height of the image
mode	the color mode of the image
data	the data address of the image
locationID	the location ID of the image

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the caller graph for this function:

◆ leImage_Draw()

leResult leImage_Draw	(	const leImage *	img,
		const leRect *	sourceRect,
		int32_t	x,
		int32_t	y,
		uint32_t	a
	)

Draw an Image.

Draws an image img bounded by sourceRect to location x and y.

leImage * fnptr;

leResult res = leImage_Draw(img);

Parameters

img	is the image to draw.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leImage_Free()

leResult leImage_Free ( leImage * img )

Free image buffer.

Frees an image buffer img.

Remarks: Buffer must be allocated using leImage_Allocate.
leImage* img;
leResult res = leImage_Free(img);

Parameters

img	the image to free

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leImage_InitDecoders()

void leImage_InitDecoders ( void )

Get Event Count.

Returns the number of events listed in the current context.

uint32_t cnt = leEvent_GetCount();

Parameters

void.

Returns: number of events.

◆ leImage_Render()

leResult leImage_Render	(	const leImage *	src,
		const leRect *	sourceRect,
		int32_t	x,
		int32_t	y,
		leBool	ignoreMask,
		leBool	ignoreAlpha,
		leImage *	dst
	)

Render image.

Copies img bounded by srcRect to location x and y. The flag ignoreMask determines if the masking color should be performed. The flag ignoreAlpha determines if the alpha blending is performed.

leImage * src;

leResult res = leImage_Render(src);

Parameters

src	is the image to render.
sourceRect	the source rectangle
x	the x position
y	the y position
ignoreMask	set to true to skip the mask stage for the source image
ignoreAlpha	the destination image to fill
dst	set to true to skip the blend stage for the source image

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

Here is the caller graph for this function:

◆ leImage_Resize()

leResult leImage_Resize	(	const leImage *	src,
		const leRect *	sourceRect,
		leImageFilterMode	mode,
		uint32_t	sizeX,
		uint32_t	sizeY,
		leImage *	target
	)

Resize image.

Resizes the source image src to destination image dst to location x and y. using the specified filter mode.

leImage * src;

leResult res = leImage_Resize(src);

Parameters

src	is the image to resize.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leImage_ResizeDraw()

leResult leImage_ResizeDraw	(	const leImage *	src,
		const leRect *	sourceRect,
		leImageFilterMode	mode,
		uint32_t	sizeX,
		uint32_t	sizeY,
		int32_t	x,
		int32_t	y,
		uint32_t	a
	)

Resize draw image.

Resizes the source image src to destination image dst to location x and y. using the specified filter mode.

leImage * src;

leResult res = fnptr->resizeDraw(src, sourceRect, mode, sizeX, sizeY, x, y, a);

Parameters

src	is the image to resize.

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leImage_Rotate()

leResult leImage_Rotate	(	const leImage *	src,
		const leRect *	sourceRect,
		leImageFilterMode	mode,
		int32_t	angle,
		leImage **	dst,
		leBool	alloc
	)

Rotate image.

Rotate image src bounded by srcRect by angle degress. The resulting image is dst The result image is automatically allocated and should be freed by the caller.

leImage * fnptr;

leResult res = leImage_Rotate(src);

Parameters

src	is the image to render.
sourceRect	the source rectangle
mode	the the filter mode
angle	the angle to rotate by (positive is counter clockwise)
dst	the destination image to fill
alloc	true if the decoder should automatically allocate the destination image

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leImage_RotateDraw()

leResult leImage_RotateDraw	(	const leImage *	src,
		const leRect *	sourceRect,
		leImageFilterMode	mode,
		int32_t	angle,
		int32_t	x,
		int32_t	y,
		uint32_t	a
	)

Rotate draw image.

Rotate image src bounded by srcRect around origin at angle degress. The resulting image is dst.

leImage * src;

leResult res = leImage_RotateDraw(src);

Parameters

src	is the image to render.
sourceRect	the source rectangle
angle	set to true to skip the mask stage for the source image
x	the destination image to fill
y	is the image to resize.
a	the alpha value to use

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ leProcessImage()

void leProcessImage	(	leImage *	img,
		size_t	addr,
		leColorMode	mode
	)

Process an image to another location.

Processes an image from one location (typically an external source) to an internally accessible memory address. The source image img will be uncompressed and rendered in a raw format to the address addr using the color mode mode. This operation is typically used to transform an image into a GPU-compatible state.

leImage* img;
uint32_t addr = 0xA0000000;
leColorMode mode = LE_COLOR_MODE_RGBA8888;
leProcessImage(img, addr, mode);

Parameters

img	the source image to process.
addr	the address of the location for the new image data
mode	the new color mode of the image

Here is the call graph for this function:

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ leImageDecoder

◆ leImageFilterMode

◆ leImageFlags

◆ leImageFormat

◆ leImageMap

Enumeration Type Documentation

◆ leImageFilterMode

◆ leImageFlags

◆ leImageFormat

Function Documentation

◆ leImage_Allocate()

◆ leImage_Copy()

◆ leImage_Create()

◆ leImage_Draw()

◆ leImage_Free()

◆ leImage_InitDecoders()

◆ leImage_Render()

◆ leImage_Resize()

◆ leImage_ResizeDraw()

◆ leImage_Rotate()

◆ leImage_RotateDraw()

◆ leProcessImage()