Appendix: Summary of Entries

This appendix groups the datatypes and functions in the 2D, 3D, and Neutrino image libraries according to their purpose. You can use this chapter to determine what you need to perform a task.

This chapter includes the following categories:

• 3D rendering
• Contexts
• Cursors
• Devices and displays
• Drawing
• Layers
• Surfaces
• Video capture

3D rendering

gf_3d_query_config()

Query the current 3D configuration

gf_3d_target_create()

Create a 3D rendering target

gf_3d_target_free()

Free a 3D rendering target

Contexts

gf_context_create()

Create a context

gf_context_free()

Free a context

gf_context_init()

Restore a context to its default settings

gf_context_set_alpha(), gf_context_disable_alpha()

Set or disable the alpha blending parameters for a context

gf_context_set_antialias(), gf_context_disable_antialias()

Set or disable antialiasing for a context

gf_context_set_bgcolor()

Set the background color for a context

gf_context_set_bgcolor_native()

Set the background color for a context, in native format

gf_context_set_capstyle()

Set the cap style for thick polylines

gf_context_set_chroma(), gf_context_disable_chroma()

Set or disable the chroma key parameters for a context

gf_context_set_clipping(), gf_context_disable_clipping()

Set or disable the clipping rectangle for a context

gf_context_set_fgcolor()

Set the foreground color for a context

gf_context_set_fgcolor_native()

Set the foreground color for a context, in native format

gf_context_set_filter()

Set the filter used to smooth scaled blits for a context

gf_context_set_linedash(), gf_context_disable_linedash()

Set or disable the dash style for polylines

gf_context_set_linejoin()

Set the join style for polylines

gf_context_set_pattern(), gf_context_disable_pattern()

Set or disable the pattern for use with raster operations

gf_context_set_penwidth()

Set the width for polylines

gf_context_set_planemask(), gf_context_disable_planemask()

Set or disable the planemask for a context

gf_context_set_polyfill()

Set the fill rule for polygons

gf_context_set_rop()

Set the raster operation for a draw context

gf_context_set_surface()

Associate a surface with a draw context

gf_context_set_surface_3d()

Associate a 3D surface with a draw context

gf_context_unset_surface()

Disassociate a surface from a draw context

gf_context_set_transform(), gf_context_disable_transform()

Set or disable the 2D transform matrix for a context

gf_context_set_translation(), gf_context_disable_translation()

Set or disable the translation for a context

Cursors

gf_cursor_enable()

Enable a hardware cursor

gf_cursor_disable()

Disable a hardware cursor

gf_cursor_set()

Replace the current hardware cursor bitmap definition

gf_cursor_set_pos()

Set the hardware cursor position

Devices and displays

gf_dev_attach()

Attach to a device

gf_dev_detach()

Detach from a device

gf_dev_get_error()

Get the last GF error from a device

gf_dev_get_meminfo()

Get memory usage information about a device

gf_dev_register_thread()

Register a graphics device initialized in another thread

gf_display_attach()

Attach to a display

gf_display_detach()

Detach from a display

gf_display_query()

Query a device for its current display mode

gf_display_query_mode()

Query a display for its supported display modes

gf_display_set_dpms()

Set the Display Power Management Signaling mode for a display

gf_display_set_external_chroma()

Set the external chroma for a display, typically for mixing an external video source to the display.

gf_display_set_layer_order()

Set the ordering of the layers for a display

gf_display_set_mode()

Set a display's mode

gf_display_snapshot()

Save the contents of a display to a surface

gf_display_wait_vsync()

Block until the next vertical synchronization

Drawing

gf_draw_begin()

Begin rendering

gf_draw_bitmap()

Draw a bitmap

gf_draw_blit1()

Blit from one area to another in a context

gf_draw_blit2()

Blit between contexts

gf_draw_blitscaled()

Blit and scale an area

gf_draw_end()

Finish rendering

gf_draw_finish()

Wait for the rendering hardware to finish

gf_draw_flush()

Flush the draw buffer

gf_draw_image()

Draw an image

gf_draw_poly_fill()

Draw a filled polygon

gf_draw_polyline()

Draw an unfilled polygon

gf_draw_rect()

Draw a rectangle

gf_draw_span()

Draw a single span

gf_draw_spanlist()

Draw a list of spans

Layers

gf_layer_attach()

Attach to a layer

gf_layer_choose_format()

Choose a format for a layer

gf_layer_detach()

Detach from a layer

gf_layer_disable()

Disable a layer

gf_layer_enable()

Enable a layer

gf_layer_query()

Query a layer's properties

gf_layer_set_blending()

Set a layer's blending

gf_layer_set_brightness()

Set a layer's brightness

gf_layer_set_chroma()

Set a layer's chroma operation

gf_layer_set_contrast()

Set a layer's contrast level

gf_layer_set_dst_viewport()

Set a layer's destination viewport

gf_layer_set_filter()

Set a layer's filter

gf_layer_set_hue()

Set a layer's hue level

gf_layer_set_outputs()

Set the display outputs the layer will appear on

gf_layer_set_saturation()

Set a layer's saturation level

gf_layer_set_src_viewport()

Set a layer's source viewport

gf_layer_set_surfaces()

Set the surface for a layer

gf_layer_update()

Update layer parameters

gf_layer_update_multi()

Update parameters for multiple layers

Surfaces

gf_surface_attach()

Allocate and attach to a surface

gf_surface_attach_by_sid()

Attach to a previously allocated surface

gf_surface_create()

Create a new surface

gf_surface_create_layer()

Create a surface for a layer

gf_surface_free()

Free a surface

gf_surface_get_info()

Get surface parameters

gf_surface_reattach()

Recycle a surface that was previously created with gf_surface_attach()

Video Capture

gf_i2c_read()

Perform an I2C master-read transaction

gf_i2c_write()

Perform an I2C master-write transaction

gf_i2c_writeread()

Perform an I2C master write/read transaction

gf_vcap_attach()

Attach to a video capture unit

gf_vcap_bind_to_layer()

Bind a video capture unit to a layer

gf_vcap_detach()

Detach from a video capture unit

gf_vcap_disable()

Disable (turn off) video capture

gf_vcap_enable()

Enable (turn on) video capture

gf_vcap_set_brightness()

Set the video capture brightness

gf_vcap_set_contrast()

Set the video capture contrast

gf_vcap_set_flags()

Set flags that determine video capture behavior

gf_vcap_set_input_dimensions()

Set the dimensions of the video capture source

gf_vcap_set_input_source()

Set the video capture source

gf_vcap_set_input_viewport()

Set the video capture input viewport

gf_vcap_set_output_dimensions()

Set the dimensions of the saved video capture frames

gf_vcap_set_saturation()

Set the video capture saturation

gf_vcap_set_sync_values()

Set the sychronization values for the video capture unit

gf_vcap_update()

Update the video capture unit parameters