http://www.directfb.org
index.html
DirectFB Reference Manual
Index Page
Interfaces
IDirectFB.html
IDirectFB
The only interface with a global "Create" function,
any other functionality goes from here.
IDirectFBScreen.html
IDirectFBScreen
Display encoder and output connector settings,
input device assignment in multi head environments,
power management, synchronization.
IDirectFBDisplayLayer.html
IDirectFBDisplayLayer
Layer configuration, creation of windows and background
configuration.
IDirectFBSurface.html
IDirectFBSurface
Surface locking, setting colorkeys and other drawing
parameters, clipping, flipping, blitting, drawing.
IDirectFBPalette.html
IDirectFBPalette
Access to palette data. Set/get entries, rotate palette.
IDirectFBWindow.html
IDirectFBWindow
Moving, resizing, raising and lowering.
Getting an interface to the window's surface.
Setting opacity and handling events.
IDirectFBInputDevice.html
IDirectFBInputDevice
Creation of input buffers and explicit state queries.
IDirectFBEventBuffer.html
IDirectFBEventBuffer
An event buffer puts events from devices or windows into a FIFO.
IDirectFBFont.html
IDirectFBFont
Getting font metrics and pixel width of a string.
IDirectFBImageProvider.html
IDirectFBImageProvider
Getting information about and loading one image from file.
IDirectFBVideoProvider.html
IDirectFBVideoProvider
Rendering video data into a surface.
IDirectFBDataBuffer.html
IDirectFBDataBuffer
Streaming or static data for image or video providers.
IDirectFBGL.html
IDirectFBGL
OpenGL context of a surface.
Types
types.html#DFBAccelerationMask
DFBAccelerationMask
Mask of accelerated functions.
types.html#DFBBoolean
DFBBoolean
A boolean.
types.html#DFBCardCapabilities
DFBCardCapabilities
Rough information about hardware capabilities.
types.html#DFBColor
DFBColor
A color defined by channels with 8bit each.
types.html#DFBColorAdjustment
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).
types.html#DFBColorAdjustmentFlags
DFBColorAdjustmentFlags
Flags defining which fields of a DFBColorAdjustment are valid.
types.html#DFBCooperativeLevel
DFBCooperativeLevel
The cooperative level controls the super interface's behaviour
in functions like SetVideoMode or CreateSurface for the primary.
types.html#DFBDataBufferDescription
DFBDataBufferDescription
Description of a data buffer that is to be created.
types.html#DFBDataBufferDescriptionFlags
DFBDataBufferDescriptionFlags
Flags defining which fields of a DFBDataBufferDescription are valid.
types.html#DFBDimension
DFBDimension
A dimension specified by width and height.
types.html#DFBDisplayLayerBackgroundMode
DFBDisplayLayerBackgroundMode
Background mode defining how to erase/initialize the area
for a windowstack repaint
types.html#DFBDisplayLayerBufferMode
DFBDisplayLayerBufferMode
Layer Buffer Mode.
types.html#DFBDisplayLayerCallback
DFBDisplayLayerCallback
Called for each existing display layer.
"layer_id" can be used to get an interface to the layer.
types.html#DFBDisplayLayerCapabilities
DFBDisplayLayerCapabilities
Capabilities of a display layer.
types.html#DFBDisplayLayerConfig
DFBDisplayLayerConfig
Layer configuration
types.html#DFBDisplayLayerConfigFlags
DFBDisplayLayerConfigFlags
Layer configuration flags
types.html#DFBDisplayLayerCooperativeLevel
DFBDisplayLayerCooperativeLevel
Cooperative level handling the access permissions.
types.html#DFBDisplayLayerDescription
DFBDisplayLayerDescription
Description of the display layer capabilities.
types.html#DFBDisplayLayerOptions
DFBDisplayLayerOptions
Used to enable some capabilities like flicker filtering or colorkeying.
types.html#DFBDisplayLayerSourceDescription
DFBDisplayLayerSourceDescription
Description of a display layer source.
types.html#DFBDisplayLayerTypeFlags
DFBDisplayLayerTypeFlags
Type of display layer for basic classification.
Values may be or'ed together.
types.html#DFBEnumerationResult
DFBEnumerationResult
Return value of callback function of enumerations.
types.html#DFBEvent
DFBEvent
General container for a DirectFB Event.
types.html#DFBEventClass
DFBEventClass
Event class.
types.html#DFBFontAttributes
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.
types.html#DFBFontDescription
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.html
IDirectFBFont::GetHeight()
.
The index field controls which face is loaded from a font file that provides a collection of
faces. This is rarely needed.
types.html#DFBFontDescriptionFlags
DFBFontDescriptionFlags
Flags defining which fields of a DFBFontDescription are valid.
types.html#DFBGetDataCallback
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.
types.html#DFBImageCapabilities
DFBImageCapabilities
Capabilities of an image.
types.html#DFBImageDescription
DFBImageDescription
Information about an image including capabilities and values
belonging to available capabilities.
types.html#DFBInputDeviceAxisIdentifier
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).
types.html#DFBInputDeviceButtonIdentifier
DFBInputDeviceButtonIdentifier
Identifier (index) for e.g. mouse or joystick buttons.
types.html#DFBInputDeviceButtonMask
DFBInputDeviceButtonMask
Flags specifying which buttons are currently down.
types.html#DFBInputDeviceButtonState
DFBInputDeviceButtonState
Specifies whether a button is currently pressed.
types.html#DFBInputDeviceCallback
DFBInputDeviceCallback
Called for each existing input device.
"device_id" can be used to get an interface to the device.
types.html#DFBInputDeviceCapabilities
DFBInputDeviceCapabilities
Basic input device features.
types.html#DFBInputDeviceDescription
DFBInputDeviceDescription
Description of the input device capabilities.
types.html#DFBInputDeviceKeyIdentifier
DFBInputDeviceKeyIdentifier
DirectFB key identifiers (for basic mapping)
types.html#DFBInputDeviceKeyState
DFBInputDeviceKeyState
Specifies whether a key is currently down.
types.html#DFBInputDeviceKeySymbol
DFBInputDeviceKeySymbol
DirectFB key symbols (for advanced mapping)
types.html#DFBInputDeviceKeyType
DFBInputDeviceKeyType
DirectFB key types (for advanced mapping)
types.html#DFBInputDeviceKeymapEntry
DFBInputDeviceKeymapEntry
One entry in the keymap of an input device.
types.html#DFBInputDeviceKeymapSymbolIndex
DFBInputDeviceKeymapSymbolIndex
Groups and levels as an index to the symbol array.
types.html#DFBInputDeviceLockState
DFBInputDeviceLockState
Flags specifying the key locks that are currently active.
types.html#DFBInputDeviceModifierKeyIdentifier
DFBInputDeviceModifierKeyIdentifier
DirectFB modifier key identifiers (for advanced mapping)
types.html#DFBInputDeviceModifierMask
DFBInputDeviceModifierMask
Flags specifying which modifiers are currently pressed.
types.html#DFBInputDeviceTypeFlags
DFBInputDeviceTypeFlags
Type of input device for basic classification.
Values may be or'ed together.
types.html#DFBInputEvent
DFBInputEvent
An input event, item of an input buffer.
types.html#DFBInputEventFlags
DFBInputEventFlags
Flags defining which additional (optional) event fields are valid.
types.html#DFBInputEventType
DFBInputEventType
The type of an input event.
types.html#DFBInsets
DFBInsets
Insets specify a distance from each edge of a rectangle.
Positive values always mean 'outside'.
types.html#DFBLocation
DFBLocation
A rectangle specified by normalized coordinates.
E.g. using 0.0, 0.0, 1.0, 1.0 would specify the whole screen.
types.html#DFBPaletteCapabilities
DFBPaletteCapabilities
The palette capabilities.
types.html#DFBPaletteDescription
DFBPaletteDescription
Description of the palette that is to be created.
types.html#DFBPaletteDescriptionFlags
DFBPaletteDescriptionFlags
Flags defining which fields of a DFBPaletteDescription are valid.
types.html#DFBPoint
DFBPoint
A point specified by x/y coordinates.
types.html#DFBRectangle
DFBRectangle
A rectangle specified by a point and a dimension.
types.html#DFBRegion
DFBRegion
A region specified by two points.
The defined region includes both endpoints.
types.html#DFBResult
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.
types.html#DFBScreenCallback
DFBScreenCallback
Called for each existing screen.
"screen_id" can be used to get an interface to the screen.
types.html#DFBScreenCapabilities
DFBScreenCapabilities
Capabilities of a screen.
types.html#DFBScreenDescription
DFBScreenDescription
Description of the display encoder capabilities.
types.html#DFBScreenEncoderCapabilities
DFBScreenEncoderCapabilities
Capabilities of a display encoder.
types.html#DFBScreenEncoderConfig
DFBScreenEncoderConfig
Configuration of a display encoder.
types.html#DFBScreenEncoderConfigFlags
DFBScreenEncoderConfigFlags
Flags for display encoder configuration.
types.html#DFBScreenEncoderDescription
DFBScreenEncoderDescription
Description of a display encoder.
types.html#DFBScreenEncoderScanMode
DFBScreenEncoderScanMode
Scan modes.
types.html#DFBScreenEncoderTVStandards
DFBScreenEncoderTVStandards
TV standards.
types.html#DFBScreenEncoderTestPicture
DFBScreenEncoderTestPicture
Test picture mode.
types.html#DFBScreenEncoderType
DFBScreenEncoderType
Type of display encoder.
types.html#DFBScreenMixerCapabilities
DFBScreenMixerCapabilities
Capabilities of a mixer.
types.html#DFBScreenMixerConfig
DFBScreenMixerConfig
Configuration of a mixer.
types.html#DFBScreenMixerConfigFlags
DFBScreenMixerConfigFlags
Flags for mixer configuration.
types.html#DFBScreenMixerDescription
DFBScreenMixerDescription
Description of a mixer.
types.html#DFBScreenMixerTree
DFBScreenMixerTree
(Sub) tree selection.
types.html#DFBScreenOutputCapabilities
DFBScreenOutputCapabilities
Capabilities of an output.
types.html#DFBScreenOutputConfig
DFBScreenOutputConfig
Configuration of an output.
types.html#DFBScreenOutputConfigFlags
DFBScreenOutputConfigFlags
Flags for screen output configuration.
types.html#DFBScreenOutputConnectors
DFBScreenOutputConnectors
Type of output connector.
types.html#DFBScreenOutputDescription
DFBScreenOutputDescription
Description of a screen output.
types.html#DFBScreenOutputSignals
DFBScreenOutputSignals
Type of output signal.
types.html#DFBScreenPowerMode
DFBScreenPowerMode
Screen Power Mode.
types.html#DFBSpan
DFBSpan
A horizontal line specified by x and width.
types.html#DFBSurfaceBlendFunction
DFBSurfaceBlendFunction
Blend functions to use for source and destination blending
types.html#DFBSurfaceBlittingFlags
DFBSurfaceBlittingFlags
Flags controlling blitting commands.
types.html#DFBSurfaceCapabilities
DFBSurfaceCapabilities
The surface capabilities.
types.html#DFBSurfaceDescription
DFBSurfaceDescription
Description of the surface that is to be created.
types.html#DFBSurfaceDescriptionFlags
DFBSurfaceDescriptionFlags
Flags defining which fields of a DFBSurfaceDescription are valid.
types.html#DFBSurfaceDrawingFlags
DFBSurfaceDrawingFlags
Flags controlling drawing commands.
types.html#DFBSurfaceFlipFlags
DFBSurfaceFlipFlags
Flipping flags controlling the behaviour of
IDirectFBSurface_Flip.html
IDirectFBSurface::Flip()
.
types.html#DFBSurfaceLockFlags
DFBSurfaceLockFlags
Flags defining the type of data access.
These are important for surface swapping management.
types.html#DFBSurfacePixelFormat
DFBSurfacePixelFormat
Pixel format of a surface.
types.html#DFBSurfacePorterDuffRule
DFBSurfacePorterDuffRule
Available Porter/Duff rules.
types.html#DFBSurfaceTextFlags
DFBSurfaceTextFlags
Flags controlling the text layout.
types.html#DFBTriangle
DFBTriangle
A triangle specified by three points.
types.html#DFBTriangleFormation
DFBTriangleFormation
Way of building triangles from the list of vertices.
types.html#DFBUserEvent
DFBUserEvent
Event for usage by the user of this library.
types.html#DFBVertex
DFBVertex
Transformed vertex of a textured triangle.
types.html#DFBVideoModeCallback
DFBVideoModeCallback
Called for each supported video mode.
types.html#DFBVideoProviderCapabilities
DFBVideoProviderCapabilities
Information about an IDirectFBVideoProvider.
types.html#DFBWindowCapabilities
DFBWindowCapabilities
Capabilities a window can have.
types.html#DFBWindowDescription
DFBWindowDescription
Description of the window that is to be created.
types.html#DFBWindowDescriptionFlags
DFBWindowDescriptionFlags
Flags defining which fields of a DFBWindowDescription are valid.
types.html#DFBWindowEvent
DFBWindowEvent
Event from the windowing system.
types.html#DFBWindowEventType
DFBWindowEventType
Window Event Types - can also be used as flags for event filters.
types.html#DFBWindowOptions
DFBWindowOptions
Flags controlling the appearance and behaviour of the window.
types.html#DFBWindowStackingClass
DFBWindowStackingClass
The stacking class restricts the stacking order of windows.
Definitions
types.html#DFB_COLOR_EQUAL (x,y)
DFB_COLOR_EQUAL (x,y)
Macro to compare two colors.
types.html#DFB_DISPLAYLAYER_IDS_ADD (ids,id)
DFB_DISPLAYLAYER_IDS_ADD (ids,id)
Adds the id to the bitmask of layer ids.
types.html#DFB_DISPLAYLAYER_IDS_EMPTY (ids)
DFB_DISPLAYLAYER_IDS_EMPTY (ids)
Empties (clears) the bitmask of layer ids.
types.html#DFB_DISPLAYLAYER_IDS_HAVE (ids,id)
DFB_DISPLAYLAYER_IDS_HAVE (ids,id)
Checks if the bitmask of layer ids contains the id.
types.html#DFB_DISPLAYLAYER_IDS_MAX
DFB_DISPLAYLAYER_IDS_MAX
Maximum number of layer ids.
types.html#DFB_DISPLAYLAYER_IDS_REMOVE (ids,id)
DFB_DISPLAYLAYER_IDS_REMOVE (ids,id)
Removes the id from the bitmask of layer ids.
types.html#DFB_LOCATION_EQUAL (a,b)
DFB_LOCATION_EQUAL (a,b)
Macro to compare two locations.
types.html#DFB_RECTANGLE_EQUAL (a,b)
DFB_RECTANGLE_EQUAL (a,b)
Macro to compare two rectangles.
types.html#DFB_REGION_EQUAL (a,b)
DFB_REGION_EQUAL (a,b)
Macro to compare two regions.
