Library Interface

This section describes the Aria User Interface Library Hardware Abstraction Layer interface.

a) Functions

	Name	Description
	GFX_ActiveContext	Gets the current set active HAL context.
	GFX_ColorBilerp	Calculates bilinear interpolation between four colors
	GFX_ColorBlend_RGBA_8888	Blends two RGBA8888 colors together using their alpha channel values.
	GFX_ColorChannelAlpha	Used for getting the alpha color channel of a given color value.
	GFX_ColorChannelBlue	Used for getting the blue color channel of a given color value.
	GFX_ColorChannelGreen	Used for getting the green color channel of a given color value.
	GFX_ColorChannelRed	Used for getting the red color channel of a given color value.
	GFX_ColorConvert	Converts a color value from one mode to another
	GFX_ColorLerp	Linear interpolation between two colors
	GFX_ColorModeInfoGet
	GFX_ColorValue	Used for getting a color value by name.
	GFX_ContextActiveSet	Sets the active context
	GFX_DrawBlit	Blits a buffer of pixels into the frame buffer.
	GFX_DrawDirectBlit	Blits a buffer of pixels into the frame buffer without performing per-pixel operations on the data.
	GFX_DrawLine	Draws a line from (x1,y1) to (x2,y2) using the current draw state.
	GFX_DrawPixel	Sets the pixel at X and Y using the current draw state.
	GFX_DrawRect	Draws a rectangle using the specified dimensions and the current draw state.
	GFX_DrawStretchBlit	Blits a buffer of pixels into the frame buffer.
	GFX_LayerFromOrientedSpace	Transforms a layer oriented space to screen space.
	GFX_LayerPointFromOrientedSpace	Transforms a point from oriented space to screen space given a layer, a display orientation, and a mirroring setting.
	GFX_LayerPointToOrientedSpace	Transforms a point from screen space to oriented space given a layer, a display orientation, and a mirroring setting.
	GFX_LayerReadBuffer	Gets the pointer to the layer's current read pixel buffer.
	GFX_LayerRectFromOrientedSpace	Transforms a layer point from oriented space to screen space given a layer, a display orientation, and a mirroring setting.
	GFX_LayerRectToOrientedSpace	Transforms a rectangle from screen space to oriented space given a layer, a display orientation, and a mirroring setting.
	GFX_LayerRotate	Swaps the width and height dimensions of a layer. Can be used for run-time display orientation
	GFX_LayerSwap	Performs a swap operation on the given layer. This advances the pointers of layer's buffer chain. The current write buffer becomes the new read buffer and a new buffer is chosen as the new write buffer. Has no effect in single buffer environments.
	GFX_LayerToOrientedSpace	Transforms a layer from screen space to oriented space.
	GFX_LayerWriteBuffer	Gets the pointer to the layer's current write pixel buffer.
	GFX_PixelBufferAreaFill	Fills an area of a pixel buffer with a solid color. Caller is responsible for ensuring that the color is the same color format as the destination buffer.
	GFX_PixelBufferAreaFill_Unsafe	Fills an area of a pixel buffer with a solid color. Caller is responsible for ensuring that the color is the same color format as the destination buffer. Like GFX_PixelBufferAreaFill but performs no bounds checking.
	GFX_PixelBufferAreaGet	Extracts a rectanglar section of pixels from a pixel buffer.
	GFX_PixelBufferAreaGet_Unsafe	Extracts a rectanglar section of pixels from a pixel buffer. Like GFX_PixelBufferAreaGet but performs no clipping between the rectangles of the extract area and the source buffer.
	GFX_PixelBufferAreaSet	Copies an area of pixels from a source buffer to a destination buffer. If the source buffer format does not match the destination format the data will be converted to match during the copy operation.
	GFX_PixelBufferAreaSet_Unsafe	Copies an area of pixels from a source buffer to a destination buffer. If the source buffer format does not match the destination format the data will be converted to match during the copy operation. Like GFX_PixelBufferAreaSet but performs no bounds checking.
	GFX_PixelBufferClipRect	Clips a rectangle against a pixel buffer. The result is guaranteed to fit inside the buffer's area.
	GFX_PixelBufferConvert	Duplicates a pixel buffer and converts the copy to another color mode.
	GFX_PixelBufferCopy	Creates a copy of the input buffer. If the input buffer's pixel data is not null then the data will be duplicated for the result buffer.
	GFX_PixelBufferCreate	Initializes a pixel buffer struct. Does not actually allocate any memory.
	GFX_PixelBufferDestroy	Destroys a pixel buffer construct. If the buffer's pixels pointer is not zero this function will attempt to free it using the provided GFX_MemoryIntf memory interface.
	GFX_PixelBufferGet	Gets the value of the pixel that resides at the provided point in the given buffer.
	GFX_PixelBufferGet_Unsafe	Gets the value of the pixel that resides at the provided point in the given buffer. Like GFX_PixelBufferGet but performs no bounds checking.
	GFX_PixelBufferGetIndex	Interprets the pixel buffer as a table of indices and looks up a specific index at position 'idx'. Indices may be 1bpp, 4bpp, or 8bpp in size and are indicated by the color mode of the pixel buffer.
	GFX_PixelBufferOffsetGet	Gets the offset address of the pixel that resides at the provided point in the given buffer.
	GFX_PixelBufferOffsetGet_Unsafe	Gets the offset address of the pixel that resides at the provided point in the given buffer. Similar to GFX_PixelBufferOffsetGet but performs no bounds checking.
	GFX_PixelBufferSet	Sets a pixel in a pixel buffer at a point to a specified color. Caller is responsible for ensuring that the input color is in the same color format as the pixel buffer.
	GFX_PixelBufferSet_Unsafe	Sets a pixel in a pixel buffer at a point to a specified color. Caller is responsible for ensuring that the input color is in the same color format as the pixel buffer. Like GFX_PixelBufferSet but performs no bounds checking.
	GFX_RectClip	Clips a rectangle to the space of another rectangle. The result rectangle is a rectangle that will fit inside both of the given rectangles.
	GFX_RectClipAdj	Returns the rectangle clipped using r_rect, and also adjusts the third rectangle
	GFX_RectCombine	Combines the area of two rectangles into a single rectangle.
	GFX_RectCompare	Returns 1 if the two rectangles have the same position and dimensions
	GFX_RectContainsPoint	Determines if a point is inside a rectangle.
	GFX_RectContainsRect	Determines if a rectangle is completely inside another rectangle. Still returns true if the edges are touching.
	GFX_RectFromPoints	Returns a GFX_Rect structure based on 2 points
	GFX_RectIntersects	Determines if two rectangles are intersecting
	GFX_RectsAreSimilar	Returns GFX_TRUE if the two rectangles are adjacent and vertically or horizontally aligned
	GFX_RectSplit	Splits two overlapping rectangles into several (up to 4) non-overlapping rectangles
	GFX_RectToPoints	Returns the points for the upper left and lower right vertices of a rectangle
	GFX_UtilMirrorPoint	Reorients a point to a given mirrored orientation.
	GFX_UtilOrientPoint	Reorients a point to a given orthogonal orientation.
	GFX_UtilPointFromOrientedSpace	Transforms a point from an oriented rectangle space to an outer space given a display orientation and a mirroring setting.
	GFX_UtilPointToOrientedSpace	Transforms a point to an oriented rectangle space to an outer space given a display orientation and a mirroring setting.
	GFX_UtilSizeFromOrientedSpace	Transforms a size tuple from oriented space to screen space
	GFX_UtilSizeToOrientedSpace	Transforms a size tuple from screen space to oriented space
	GFX_UtilSortPointsX	Sorts two points in the X axis
	GFX_UtilSortPointsY	Sorts two points in the Y axis

b) Data Types and Constants

	Name	Description
	GFX_ANTIALIAS_MODE_COUNT	This is macro GFX_ANTIALIAS_MODE_COUNT.
	GFX_AntialiasMode	Enables anti-aliased drawing hint
	GFX_AntialiasMode_t	Enables anti-aliased drawing hint
	GFX_ASSERT	This is macro GFX_ASSERT.
	GFX_BitsPerPixel	List of available bits-per-pixel sizes.
	GFX_BitsPerPixel_t	List of available bits-per-pixel sizes.
	GFX_BlendMode	Blend mode masks
	GFX_BlendMode_t	Blend mode masks
	GFX_BufferSelection	Buffer selector used when querying layers for certain buffer states.
	GFX_BufferSelection_t	Buffer selector used when querying layers for certain buffer states.
	GFX_BufferState	Frame buffer memory states
	GFX_BufferState_t	Frame buffer memory states
	GFX_Calloc_FnPtr	Simple wrapper around the standard calloc function pointer. Used for redirecting memory allocation to other memory management systems.
	GFX_COLOR_MAX_SIZE	This is macro GFX_COLOR_MAX_SIZE.
	GFX_COLOR_MODE_COUNT	This is macro GFX_COLOR_MODE_COUNT.
	GFX_COLOR_MODE_IS_ALPHA	This is macro GFX_COLOR_MODE_IS_ALPHA.
	GFX_COLOR_MODE_IS_INDEX	This is macro GFX_COLOR_MODE_IS_INDEX.
	GFX_COLOR_MODE_IS_PIXEL	This is macro GFX_COLOR_MODE_IS_PIXEL.
	GFX_COLOR_MODE_LAST_COLOR	This is macro GFX_COLOR_MODE_LAST_COLOR.
	GFX_ColorInfo	This is variable GFX_ColorInfo.
	GFX_ColorMask	Maskable list of color valies.
	GFX_ColorMask_t	Maskable list of color valies.
	GFX_ColorMode	List of available color modes.
	GFX_ColorMode_t	List of available color modes.
	GFX_ColorModeInfo	Struct that provides information about a color mode.
	GFX_ColorModeInfo_t	Struct that provides information about a color mode.
	GFX_ColorName	Color name reference table
	GFX_ColorName_t	Color name reference table
	GFX_Context	An instance of the hardware abstraction layer.
	GFX_Context_t	An instance of the hardware abstraction layer.
	GFX_DEPRECATED	This is macro GFX_DEPRECATED.
	GFX_DisplayInfo	Describes a graphical display device.
	GFX_DisplayInfo_t	Describes a graphical display device.
	GFX_DRAW_MODE_COUNT	This is macro GFX_DRAW_MODE_COUNT.
	GFX_DrawMode	Gradient draw modes.
	GFX_DrawMode_t	Gradient draw modes.
	GFX_DrawPipeline
	GFX_DrawState	A list of drawing hints for shape drawing algorithms
	GFX_DrawState_t	A list of drawing hints for shape drawing algorithms
	GFX_DriverInfo	A driver description structure.
	GFX_DriverInfo_t	A driver description structure.
	GFX_Flag	Hardware abstraction state interface flags. See gfx.h for a comprehensive description.
	GFX_Flag_t	Hardware abstraction state interface flags. See gfx.h for a comprehensive description.
	GFX_FrameBuffer	A frame buffer is a wrapper around a pixel buffer construct that is used by display drivers to manage frame buffers.
	GFX_FrameBuffer_t	A frame buffer is a wrapper around a pixel buffer construct that is used by display drivers to manage frame buffers.
	GFX_Free_FnPtr	Simple wrapper around the standard free function pointer. Used for redirecting memory free to other memory management systems.
	GFX_Layer	Layers describe basic display drawing areas and are meant to map directly to graphics controller hardware layers.
	GFX_Layer_t	Layers describe basic display drawing areas and are meant to map directly to graphics controller hardware layers.
	GFX_Malloc_FnPtr	Simple wrapper around the standard malloc function pointer. Used for redirecting memory allocation to other memory management systems.
	GFX_Memcpy_FnPtr	Simple wrapper around the standard memcpy function pointer. Used for redirecting memcpy to other memory management systems.
	GFX_MemoryIntf	Custom memory manager interface.
	GFX_MemoryIntf_t	Custom memory manager interface.
	GFX_Memset_FnPtr	Simple wrapper around the standard memset function pointer. Used for redirecting memset to other memory management systems.
	GFX_NUM_FLAGS	This is macro GFX_NUM_FLAGS.
	GFX_Orientation	Orthogonal orientation settings.
	GFX_Orientation_t	Orthogonal orientation settings.
	GFX_PIPELINE_MODE_COUNT	This is macro GFX_PIPELINE_MODE_COUNT.
	GFX_PipelineMode	Hardware draw path settings.
	GFX_PipelineMode_t	Hardware draw path settings.
	GFX_PixelBuffer	A pixel buffer is a wrapper around a basic data pointer. A pixel buffer has a color mode, a pixel count, a rectangular dimension, a pixel count, and a lenght in bytes.
	GFX_PixelBuffer_t	A pixel buffer is a wrapper around a basic data pointer. A pixel buffer has a color mode, a pixel count, a rectangular dimension, a pixel count, and a lenght in bytes.
	GFX_Point_t	A two dimensional Cartesian point.
	GFX_Realloc_FnPtr	Simple wrapper around the standard realloc function pointer. Used for redirecting memory allocation to other memory management systems.
	GFX_Rect_t	A rectangle definition.
	GFX_ResizeMode	The algorithm used for resizing a frame
	GFX_ResizeMode_t	The algorithm used for resizing a frame
	GFX_Size	A two dimensional indication of size. Values are signed but should never be negative.
	GFX_Size_t	A two dimensional indication of size. Values are signed but should never be negative.
	RGB_2_BITS	This is macro RGB_2_BITS.
	RGB_3_BITS	This is macro RGB_3_BITS.
	RGB_332_BLUE_MASK	This is macro RGB_332_BLUE_MASK.
	RGB_332_GREEN_MASK	This is macro RGB_332_GREEN_MASK.
	RGB_332_RED_MASK	This is macro RGB_332_RED_MASK.
	RGB_5_BITS	This is macro RGB_5_BITS.
	RGB_565_BLUE_MASK	This is macro RGB_565_BLUE_MASK.
	RGB_565_GREEN_MASK	This is macro RGB_565_GREEN_MASK.
	RGB_565_RED_MASK	This is macro RGB_565_RED_MASK.
	RGB_6_BITS	This is macro RGB_6_BITS.
	RGB_8_BITS	This is macro RGB_8_BITS.
	RGB_888_BLUE_MASK	This is macro RGB_888_BLUE_MASK.
	RGB_888_GREEN_MASK	This is macro RGB_888_GREEN_MASK.
	RGB_888_RED_MASK	This is macro RGB_888_RED_MASK.
	RGBA_5551_ALPHA_MASK	This is macro RGBA_5551_ALPHA_MASK.
	RGBA_5551_BLUE_MASK	This is macro RGBA_5551_BLUE_MASK.
	RGBA_5551_GREEN_MASK	This is macro RGBA_5551_GREEN_MASK.
	RGBA_5551_RED_MASK	This is macro RGBA_5551_RED_MASK.
	RGBA_8888_ALPHA_MASK	This is macro RGBA_8888_ALPHA_MASK.
	RGBA_8888_BLUE_MASK	This is macro RGBA_8888_BLUE_MASK.
	RGBA_8888_GREEN_MASK	This is macro RGBA_8888_GREEN_MASK.
	RGBA_8888_RED_MASK	This is macro RGBA_8888_RED_MASK.

MPLAB® Harmony Graphics Suite > Graphics Library > Aria Graphics Library > Aria Hardware Abstraction Layer (HAL) > Library Interface

MPLAB® Harmony Graphics Suite

Contents | Home

Previous | Up | Next

Documentation Feedback
Microchip Support