/* (c) Copyright 2001-2009 The world wide DirectFB Open Source Community (directfb.org) (c) Copyright 2000-2004 Convergence (integrated media) GmbH All rights reserved. Written by Denis Oliver Kropp , Andreas Hundt , Sven Neumann , Ville Syrjälä and Claudio Ciccani . This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef __DFB__CORE__SCREENS_H__ #define __DFB__CORE__SCREENS_H__ #include #include typedef DFBEnumerationResult (*CoreScreenCallback) (CoreScreen *screen, void *ctx); typedef enum { CMSF_NONE = 0x00000000, /* none of these */ CMSF_DIMENSION = 0x00000001, /* dimension is set */ CMSF_ALL = 0x00000001, /* all of these */ } CoreMixerStateFlags; typedef struct { CoreMixerStateFlags flags; DFBDimension dimension; } CoreMixerState; typedef struct { /** Driver Control **/ /* * Return size of screen data (shared memory). */ int (*ScreenDataSize)(void); /* * Called once by the master to initialize screen data and reset hardware. * Driver has to fill the screen description. */ DFBResult (*InitScreen) ( CoreScreen *screen, CoreGraphicsDevice *device, void *driver_data, void *screen_data, DFBScreenDescription *description ); /* * Called once by the master for each mixer. * Driver fills description and default config. */ DFBResult (*InitMixer) ( CoreScreen *screen, void *driver_data, void *screen_data, int mixer, DFBScreenMixerDescription *description, DFBScreenMixerConfig *config ); /* * Called once by the master for each encoder. * Driver fills description and default config. */ DFBResult (*InitEncoder) ( CoreScreen *screen, void *driver_data, void *screen_data, int encoder, DFBScreenEncoderDescription *description, DFBScreenEncoderConfig *config ); /* * Called once by the master for each output. * Driver fills description and default config. */ DFBResult (*InitOutput) ( CoreScreen *screen, void *driver_data, void *screen_data, int output, DFBScreenOutputDescription *description, DFBScreenOutputConfig *config ); /** Power management **/ /* * Switch between "on", "standby", "suspend" and "off". */ DFBResult (*SetPowerMode) ( CoreScreen *screen, void *driver_data, void *screen_data, DFBScreenPowerMode mode ); /** Synchronization **/ /* * Wait for the vertical retrace. */ DFBResult (*WaitVSync) ( CoreScreen *screen, void *driver_data, void *screen_data ); /** Mixer configuration **/ /* * Test if configuration is supported. Store failing fields in 'failed'. */ DFBResult (*TestMixerConfig)( CoreScreen *screen, void *driver_data, void *screen_data, int mixer, const DFBScreenMixerConfig *config, DFBScreenMixerConfigFlags *failed ); /* * Set new configuration. */ DFBResult (*SetMixerConfig) ( CoreScreen *screen, void *driver_data, void *screen_data, int mixer, const DFBScreenMixerConfig *config ); /** Encoder configuration **/ /* * Test if configuration is supported. Store failing fields in 'failed'. */ DFBResult (*TestEncoderConfig)( CoreScreen *screen, void *driver_data, void *screen_data, int encoder, const DFBScreenEncoderConfig *config, DFBScreenEncoderConfigFlags *failed ); /* * Set new configuration. */ DFBResult (*SetEncoderConfig) ( CoreScreen *screen, void *driver_data, void *screen_data, int encoder, const DFBScreenEncoderConfig *config ); /** Output configuration **/ /* * Test if configuration is supported. Store failing fields in 'failed'. */ DFBResult (*TestOutputConfig)( CoreScreen *screen, void *driver_data, void *screen_data, int output, const DFBScreenOutputConfig *config, DFBScreenOutputConfigFlags *failed ); /* * Set new configuration. */ DFBResult (*SetOutputConfig) ( CoreScreen *screen, void *driver_data, void *screen_data, int output, const DFBScreenOutputConfig *config ); /** Screen configuration **/ /* * Return the screen size, e.g. as a basis for positioning a layer. * * This function might be replaced soon. */ DFBResult (*GetScreenSize) ( CoreScreen *screen, void *driver_data, void *screen_data, int *ret_width, int *ret_height ); /** States **/ DFBResult (*GetMixerState) ( CoreScreen *screen, void *driver_data, void *screen_data, int mixer, CoreMixerState *ret_state ); } ScreenFuncs; /* * Add a screen to a graphics device by pointing to a table containing * driver functions. The driver data will be passed to these functions. */ CoreScreen *dfb_screens_register( CoreGraphicsDevice *device, void *driver_data, ScreenFuncs *funcs ); /* * Replace functions of the primary screen implementation by passing * an alternative driver function table. All non-NULL functions in the new * table replace the functions in the original function table. * The original function table is written to 'primary_funcs' before to allow * drivers to use existing functionality from the original implementation. */ CoreScreen *dfb_screens_hook_primary( CoreGraphicsDevice *device, void *driver_data, ScreenFuncs *funcs, ScreenFuncs *primary_funcs, void **primary_driver_data ); /* * Replace the default implementation for the primary screen. */ CoreScreen *dfb_screens_register_primary( CoreGraphicsDevice *device, void *driver_data, ScreenFuncs *funcs ); /* * Enumerate all registered screens by invoking the callback for each screen. */ void dfb_screens_enumerate( CoreScreenCallback callback, void *ctx ); /* * Returns the screen with the specified ID. */ CoreScreen *dfb_screens_at( DFBScreenID screen_id ); CoreScreen *dfb_screens_at_translated( DFBScreenID screen_id ); /* * Return the (translated) ID of the specified screen. */ DFBScreenID dfb_screen_id_translated( CoreScreen *screen ); #endif