pgfx.h File Reference

Main Page Modules Alphabetical List Compound List File List Compound Members File Members

# /home/micah/picogui/pg1/client/c/include/picogui/pgfx.h File Reference

PGFX Graphics API Header. More...

Go to the source code of this file.

## Compounds
struct | pgfx_context
| Rendering context. More...
struct | pgfx_lib
| Defines the rendering backend. More...
## Defines
#define | PGFX_IMMEDIATE 1
| PGFX canvas immediate mode.
#define | PGFX_PERSISTENT 2
| PGFX canvas persistent mode.
## Typedefs
typedef int | pgu
| Unit for coordinates in PGFX.
typedef int | pgprim
| Reference to a stored primitive.
typedef pgfx_context * | pgcontext
| Rendering context.
## Functions
pgprim | pgPixel (pgcontext c, pgu x, pgu y)
| Plot a single pixel in the current color.
pgprim | pgLine (pgcontext c, pgu x1, pgu y1, pgu x2, pgu y2)
| Plot a line between two specified coordinate pairs.
pgprim | pgRect (pgcontext c, pgu x, pgu y, pgu w, pgu h)
| Draw a filled rectangle in the current color.
pgprim | pgFrame (pgcontext c, pgu x, pgu y, pgu w, pgu h)
| Draw a non-filled rectangle in the current color.
pgprim | pgSlab (pgcontext c, pgu x, pgu y, pgu w)
| Draw a horizontal line beginning at `(x,y)` and extending right `w` pixels.
pgprim | pgBar (pgcontext c, pgu x, pgu y, pgu h)
| Draw a vertical line beginning at `(x,y)` and extending down `h` pixels.
pgprim | pgEllipse (pgcontext c, pgu x, pgu y, pgu w, pgu h)
| Draw a non-filled ellipse in the current color.
pgprim | pgFEllipse (pgcontext c, pgu x, pgu y, pgu w, pgu h)
| Draw a filled ellipse in the current color.
pgprim | pgFPolygon (pgcontext c, pghandle array)
| Draw a filled polygon in the current color.
pgprim | pgBlur (pgcontext c, pgu x, pgu y, pgu w, pgu h, pgu radius)
| Blur an area of the screen.
pgprim | pgText (pgcontext c, pgu x, pgu y, pghandle string)
| Draw a string in the current color, font, and angle.
pgprim | pgBitmap (pgcontext c, pgu x, pgu y, pgu w, pgu h, pghandle bitmap)
| Draw a bitmap.
pgprim | pgRotateBitmap (pgcontext c, pgu x, pgu y, pgu w, pgu h, pghandle bitmap)
| Rotate and draw a bitmap.
pgprim | pgTileBitmap (pgcontext c, pgu x, pgu y, pgu w, pgu h, pghandle bitmap)
| Tile a portion of a bitmap.
pgprim | pgGradient (pgcontext c, pgu x, pgu y, pgu w, pgu h, pgu angle, pgcolor c1, pgcolor c2)
| Render a linear color gradient.
pgprim | pgSetColor (pgcontext c, pgcolor color)
| Set the current color.
pgprim | pgSetFont (pgcontext c, pghandle font)
| Set the current font.
pgprim | pgSetLgop (pgcontext c, short lgop)
| Set the current logical operation.
pgprim | pgSetAngle (pgcontext c, pgu angle)
| Set the angle for text and bitmap.
pgprim | pgSetSrc (pgcontext c, pgu x, pgu y, pgu w, pgu h)
| Set the bitmap source rectangle.
pgprim | pgSetMapping (pgcontext c, pgu x, pgu y, pgu w, pgu h, short type)
| Set coordinate system mapping.
pgprim | pgSetClip (pgcontext c, pgu x, pgu y, pgu w, pgu h)
| Sets the context's clipping rectangle.
void | pgContextUpdate (pgcontext c)
| Draws any undrawn primitives.
void | pgMoveTo (pgcontext c, pgu x, pgu y)
| Sets a position to draw lines from.
pgprim | pgLineTo (pgcontext c, pgu x, pgu y)
| Draws a line from the position last set with pgMoveTo or pgLineTo.
pgcontext | pgNewCanvasContext (pghandle canvas, short mode)
| Create a context for rendering to a canvas.
pgcontext | pgNewBitmapContext (pghandle bitmap)
| Create a context for rendering to a bitmap.
void | pgDeleteContext (pgcontext c)
| Delete a PGFX context.

## Detailed Description

PGFX Graphics API Header.

PGFX is an abstract interface to graphics primitives. It provides a higher level method of using the Canvas widget and other graphics output devices. Usually this file does not need to be included separately, it is included with `#include <picogui.h>`