Reference Manual - 1.0.1
Index Page

Interfaces

IDirectFB Main interface of DirectFB, created by DirectFBCreate().
IDirectFBScreen Interface to different display outputs, encoders, connector settings, power management and synchronization.
IDirectFBDisplayLayer Layer interface for configuration, window stack usage or direct surface access, with shared/exclusive context.
IDirectFBSurface Interface to a surface object, being a graphics context for rendering and state control, buffer operations, palette access and sub area translate'n'clip logic.
IDirectFBPalette Interface for read/write access to the colors of a palette object and for cloning it.
IDirectFBWindow Interface to a window object, controlling appearance and focus, positioning and stacking, event buffers and surface access.
IDirectFBInputDevice Input device interface for keymap access, event buffers and state queries.
IDirectFBEventBuffer Interface to a local event buffer to send/receive events, wait for events, abort waiting or reset buffer.
IDirectFBFont Font interface for getting metrics, measuring strings or single characters, query/choose encodings.
IDirectFBImageProvider Interface to an image provider, retrieving information about the image and rendering it to a surface.
IDirectFBVideoProvider Interface to a video provider for playback with advanced control and basic stream information.
IDirectFBDataBuffer Data buffer interface, providing unified access to different kinds of data storage and live feed.
IDirectFBGL OpenGL context of a surface.

Types

DFBAccelerationMask Mask of accelerated functions.
DFBBoolean A boolean.
DFBColor A color defined by channels with 8bit each.
DFBColorAdjustment Color Adjustment used to adjust video colors.

All fields are in the range 0x0 to 0xFFFF with 0x8000 as the default value (no adjustment).
DFBColorAdjustmentFlags Flags defining which fields of a DFBColorAdjustment are valid.
DFBCooperativeLevel The cooperative level controls the super interface's behaviour in functions like SetVideoMode or CreateSurface for the primary.
DFBDataBufferDescription Description of a data buffer that is to be created.
DFBDataBufferDescriptionFlags Flags defining which fields of a DFBDataBufferDescription are valid.
DFBDimension A dimension specified by width and height.
DFBDisplayLayerBackgroundMode Background mode defining how to erase/initialize the area for a windowstack repaint
DFBDisplayLayerBufferMode Layer Buffer Mode.
DFBDisplayLayerCallback Called for each existing display layer. "layer_id" can be used to get an interface to the layer.
DFBDisplayLayerCapabilities Capabilities of a display layer.
DFBDisplayLayerConfig Layer configuration
DFBDisplayLayerConfigFlags Layer configuration flags
DFBDisplayLayerCooperativeLevel Cooperative level handling the access permissions.
DFBDisplayLayerDescription Description of the display layer capabilities.
DFBDisplayLayerOptions Used to enable some capabilities like flicker filtering or colorkeying.
DFBDisplayLayerSourceDescription Description of a display layer source.
DFBDisplayLayerTypeFlags Type of display layer for basic classification. Values may be or'ed together.
DFBEnumerationResult Return value of callback function of enumerations.
DFBEvent General container for a DirectFB Event.
DFBEventBufferStats Statistics about event buffer queue.
DFBEventClass Event class.
DFBFontAttributes Flags describing how to load a font.

These flags describe how a font is loaded and affect how the glyphs are drawn. There is no way to change this after the font has been loaded. If you need to render a font with different attributes, you have to create multiple FontProviders of the same font file.
DFBFontDescription Description of how to load glyphs from a font file.

The attributes control how the glyphs are rendered. Width and height can be used to specify the desired face size in pixels. If you are loading a non-scalable font, you shouldn't specify a font size.

Please note that the height value in the DFBFontDescription doesn't correspond to the height returned by IDirectFBFont::GetHeight().

The index field controls which face is loaded from a font file that provides a collection of faces. This is rarely needed.

Fractional sizes (fract_height and fract_width) are 26.6 fixed point integers and override the pixel sizes if both are specified.
DFBFontDescriptionFlags Flags defining which fields of a DFBFontDescription are valid.
DFBGLAttributes Attributes of an OpenGL context.
DFBGetDataCallback Called for each block of continous data requested, e.g. by a Video Provider. Write as many data as you can but not more than specified by length. Return the number of bytes written or 'EOF' if no data is available anymore.
DFBGraphicsDeviceDescription Description of the graphics device capabilities.
DFBGraphicsDriverInfo
DFBImageCapabilities Capabilities of an image.
DFBImageDescription Information about an image including capabilities and values belonging to available capabilities.
DFBInputDeviceAxisIdentifier Axis identifier (index) for e.g. mouse or joystick.

The X, Y and Z axis are predefined. To access other axes, use DIAI_FIRST plus a zero based index, e.g. the 4th axis would be (DIAI_FIRST + 3).
DFBInputDeviceButtonIdentifier Identifier (index) for e.g. mouse or joystick buttons.
DFBInputDeviceButtonMask Flags specifying which buttons are currently down.
DFBInputDeviceButtonState Specifies whether a button is currently pressed.
DFBInputDeviceCallback Called for each existing input device. "device_id" can be used to get an interface to the device.
DFBInputDeviceCapabilities Basic input device features.
DFBInputDeviceDescription Description of the input device capabilities.
DFBInputDeviceKeyIdentifier DirectFB key identifiers (for basic mapping)
DFBInputDeviceKeyState Specifies whether a key is currently down.
DFBInputDeviceKeySymbol DirectFB key symbols (for advanced mapping)
DFBInputDeviceKeyType DirectFB key types (for advanced mapping)
DFBInputDeviceKeymapEntry One entry in the keymap of an input device.
DFBInputDeviceKeymapSymbolIndex Groups and levels as an index to the symbol array.
DFBInputDeviceLockState Flags specifying the key locks that are currently active.
DFBInputDeviceModifierKeyIdentifier DirectFB modifier key identifiers (for advanced mapping)
DFBInputDeviceModifierMask Flags specifying which modifiers are currently pressed.
DFBInputDeviceTypeFlags Type of input device for basic classification. Values may be or'ed together.
DFBInputEvent An input event, item of an input buffer.
DFBInputEventFlags Flags defining which additional (optional) event fields are valid.
DFBInputEventType The type of an input event.
DFBInsets Insets specify a distance from each edge of a rectangle.

Positive values always mean 'outside'.
DFBLocation A rectangle specified by normalized coordinates.

E.g. using 0.0, 0.0, 1.0, 1.0 would specify the whole screen.
DFBPaletteCapabilities The palette capabilities.
DFBPaletteDescription Description of the palette that is to be created.
DFBPaletteDescriptionFlags Flags defining which fields of a DFBPaletteDescription are valid.
DFBPoint A point specified by x/y coordinates.
DFBRectangle A rectangle specified by a point and a dimension.
DFBRegion A region specified by two points.

The defined region includes both endpoints.
DFBResult Every interface method returns this result code.
Any other value to be returned adds an argument pointing to a location the value should be written to.
DFBScreenCallback Called for each existing screen. "screen_id" can be used to get an interface to the screen.
DFBScreenCapabilities Capabilities of a screen.
DFBScreenDescription Description of the display encoder capabilities.
DFBScreenEncoderCapabilities Capabilities of a display encoder.
DFBScreenEncoderConfig Configuration of a display encoder.
DFBScreenEncoderConfigFlags Flags for display encoder configuration.
DFBScreenEncoderDescription Description of a display encoder.
DFBScreenEncoderScanMode Scan modes.
DFBScreenEncoderTVStandards TV standards.
DFBScreenEncoderTestPicture Test picture mode.
DFBScreenEncoderType Type of display encoder.
DFBScreenMixerCapabilities Capabilities of a mixer.
DFBScreenMixerConfig Configuration of a mixer.
DFBScreenMixerConfigFlags Flags for mixer configuration.
DFBScreenMixerDescription Description of a mixer.
DFBScreenMixerTree (Sub) tree selection.
DFBScreenOutputCapabilities Capabilities of an output.
DFBScreenOutputConfig Configuration of an output.
DFBScreenOutputConfigFlags Flags for screen output configuration.
DFBScreenOutputConnectors Type of output connector.
DFBScreenOutputDescription Description of a screen output.
DFBScreenOutputSignals Type of output signal.
DFBScreenOutputSlowBlankingSignals Type of slow blanking signalling.
DFBScreenPowerMode Screen Power Mode.
DFBSpan A horizontal line specified by x and width.
DFBStreamCapabilities Capabilities of an audio/video stream.
DFBStreamDescription Informations about an audio/video stream.
DFBSurfaceBlendFunction Blend functions to use for source and destination blending
DFBSurfaceBlittingFlags Flags controlling blitting commands.
DFBSurfaceCapabilities The surface capabilities.
DFBSurfaceDescription Description of the surface that is to be created.
DFBSurfaceDescriptionFlags Flags defining which fields of a DFBSurfaceDescription are valid.
DFBSurfaceDrawingFlags Flags controlling drawing commands.
DFBSurfaceFlipFlags Flipping flags controlling the behaviour of IDirectFBSurface::Flip().
DFBSurfaceLockFlags Flags defining the type of data access. These are important for surface swapping management.
DFBSurfacePixelFormat Pixel format of a surface.
DFBSurfacePorterDuffRule Available Porter/Duff rules.
DFBSurfaceTextFlags Flags controlling the text layout.
DFBTextEncodingCallback Called for each provided text encoding.
DFBTriangle A triangle specified by three points.
DFBTriangleFormation Way of building triangles from the list of vertices.
DFBUniversalEvent Universal event for custom usage with variable size.
DFBUserEvent Event for usage by the user of this library.
DFBVertex Transformed vertex of a textured triangle.
DFBVideoModeCallback Called for each supported video mode.
DFBVideoProviderCapabilities Information about an IDirectFBVideoProvider.
DFBVideoProviderPlaybackFlags Flags controlling playback mode of a IDirectFBVideoProvider.
DFBVideoProviderStatus Information about the status of an IDirectFBVideoProvider.
DFBWindowCapabilities Capabilities a window can have.
DFBWindowDescription Description of the window that is to be created.
DFBWindowDescriptionFlags Flags defining which fields of a DFBWindowDescription are valid.
DFBWindowEvent Event from the windowing system.
DFBWindowEventType Window Event Types - can also be used as flags for event filters.
DFBWindowOptions Flags controlling the appearance and behaviour of the window.
DFBWindowStackingClass The stacking class restricts the stacking order of windows.
DIRenderCallbackResult

Definitions

DFB_COLOR_EQUAL (x,y) Macro to compare two colors.
DFB_DISPLAYLAYER_IDS_ADD (ids,id) Adds the id to the bitmask of layer ids.
DFB_DISPLAYLAYER_IDS_EMPTY (ids) Empties (clears) the bitmask of layer ids.
DFB_DISPLAYLAYER_IDS_HAVE (ids,id) Checks if the bitmask of layer ids contains the id.
DFB_DISPLAYLAYER_IDS_MAX Maximum number of layer ids.
DFB_DISPLAYLAYER_IDS_REMOVE (ids,id) Removes the id from the bitmask of layer ids.
DFB_LOCATION_EQUAL (a,b) Macro to compare two locations.
DFB_RECTANGLE_EQUAL (a,b) Macro to compare two rectangles.
DFB_REGION_EQUAL (a,b) Macro to compare two regions.
DIRECTFBGL_INTERFACE_VERSION The DirectFBGL interface version.
DTEID_UTF8 Predefined text encoding IDs.

Creative Commons License This work is licensed under a Creative Commons Attribution-Share Alike 3.0 License