From 5e5ba6a0761433ab2efcdc2472367e7b30587ff7 Mon Sep 17 00:00:00 2001 From: Timo Lotterbach Date: Tue, 31 Jan 2012 11:19:17 +0100 Subject: [PATCH] ilmClient: reduced the groups inside the documentation Since the configuration is now generated on a project global scope, too many subgroups would make the resulting documentation way too complex. --- LayerManagerClient/ilmClient/include/ilm_client.h | 150 +++++++++++----------- 1 file changed, 72 insertions(+), 78 deletions(-) diff --git a/LayerManagerClient/ilmClient/include/ilm_client.h b/LayerManagerClient/ilmClient/include/ilm_client.h index 7096a2e..626afef 100644 --- a/LayerManagerClient/ilmClient/include/ilm_client.h +++ b/LayerManagerClient/ilmClient/include/ilm_client.h @@ -25,18 +25,12 @@ extern "C" { #include "ilm_types.h" /** - * \defgroup LifeCycleManagement Life Cycle Management - * \defgroup Configuration Configuration Functions - * \defgroup Screen Screen Functions - * \defgroup LayerGroup Layer Group Functions - * \defgroup Layer Layer Functions - * \defgroup SurfaceGroup Surface Group Functions - * \defgroup Surface Surface Functions + * \defgroup ilmClient Layer Management Client API */ /** * \brief Initializes the IVI LayerManagement Client. - * \ingroup LifeCycleManagement + * \ingroup ilmClient * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if a connection can not be established to the services. */ @@ -44,7 +38,7 @@ ilmErrorTypes ilm_init(); /** * \brief Get the screen resolution of a specific screen from the Layermanagement - * \ingroup Screen + * \ingroup ilmClient * \param[in] screenID Screen Indentifier as a Number from 0 .. MaxNumber of Screens * \param[out] pWidth pointer where width of screen should be stored * \param[out] pHeight pointer where height of screen should be stored @@ -55,7 +49,7 @@ ilmErrorTypes ilm_getScreenResolution(t_ilm_uint screenID, t_ilm_uint* pWidth, t /** * \brief Get the surface properties from the Layermanagement - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceID surface Indentifier as a Number from 0 .. MaxNumber of Surfaces * \param[out] pSurfaceProperties pointer where the surface properties should be stored * \return ILM_TRUE if the method call was successful @@ -65,7 +59,7 @@ ilmErrorTypes ilm_getPropertiesOfSurface(t_ilm_uint surfaceID, struct ilmSurface /** * \brief Get the layer properties from the Layermanagement - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerID layer Indentifier as a Number from 0 .. MaxNumber of Layer * \param[out] pLayerProperties pointer where the layer properties should be stored * \return ILM_TRUE if the method call was successful @@ -75,7 +69,7 @@ ilmErrorTypes ilm_getPropertiesOfLayer(t_ilm_uint layerID, struct ilmLayerProper /** * \brief Get the number of hardware layers of a screen - * \ingroup Layer + * \ingroup ilmClient * \param[in] screenID id of the screen, where the number of Hardware Layers should be returned * \param[out] pNumberOfHardwareLayers pointer where the number of hardware layers should be stored * \return ILM_TRUE if the method call was successful @@ -85,7 +79,7 @@ ilmErrorTypes ilm_getNumberOfHardwareLayers(t_ilm_uint screenID, t_ilm_uint* pNu /** * \brief Get the screen Ids - * \ingroup Screen + * \ingroup ilmClient * \param[out] pNumberOfIDs pointer where the number of Screen Ids should be returned * \param[out] ppIDs pointer to array where the IDs should be stored * \return ILM_TRUE if the method call was successful @@ -95,7 +89,7 @@ ilmErrorTypes ilm_getScreenIDs(t_ilm_uint* pNumberOfIDs, t_ilm_uint** ppIDs); /** * \brief Destroys the IVI LayerManagement Client. - * \ingroup LifeCycleManagement + * \ingroup ilmClient * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not be closed or was not initialized. */ @@ -103,7 +97,7 @@ ilmErrorTypes ilm_destroy(); /** * \brief Get all LayerIds which are currently registered and managed by the services - * \ingroup Layer + * \ingroup ilmClient * \param[out] pLength Pointer where length of ids array should be stored * \param[out] ppArray Array where the ids should be stored, * the array will be allocated inside @@ -114,7 +108,7 @@ ilmErrorTypes ilm_getLayerIDs(t_ilm_int* pLength,t_ilm_layer** ppArray); /** * \brief Get all LayerIds of the given screen - * \ingroup Screen + * \ingroup ilmClient * \param[in] screenID The id of the screen to get the layer IDs of * \param[out] pLength Pointer where length of ids array should be stored * \param[out] ppArray Array where the ids should be stored, @@ -126,7 +120,7 @@ ilmErrorTypes ilm_getLayerIDsOnScreen(t_ilm_uint screenID, t_ilm_int* pLength,t_ /** * \brief Get all SurfaceIDs which are currently registered and managed by the services - * \ingroup Surface + * \ingroup ilmClient * \param[out] pLength Pointer where length of ids array should be stored * \param[out] ppArray Array where the ids should be stored, * the array will be allocated inside @@ -137,7 +131,7 @@ ilmErrorTypes ilm_getSurfaceIDs(t_ilm_int* pLength,t_ilm_surface** ppArray); /** * \brief Get all LayerGroupIds which are currently registered and managed by the services - * \ingroup LayerGroup + * \ingroup ilmClient * \param[out] pLength Pointer where array length of ids should be stored * \param[out] ppArray Array where the id should be stored, * the array will be allocated inside @@ -148,7 +142,7 @@ ilmErrorTypes ilm_getLayerGroupIDs(t_ilm_int* pLength,t_ilm_layergroup** ppArray /** * \brief Get all SurfaceGroupIds which are currently registered and managed by the services - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[out] pLength Pointer where array length of ids should be stored * \param[out] ppArray Array where the id should be stored, * the array will be allocated inside @@ -159,7 +153,7 @@ ilmErrorTypes ilm_getSurfaceGroupIDs(t_ilm_int* pLength,t_ilm_surfacegroup** ppA /** * \brief Get all SurfaceIds which are currently registered to a given layer and are managed by the services - * \ingroup Layer + * \ingroup ilmClient * \param[in] layer Id of the Layer whose surfaces are to be returned * \param[out] pLength Pointer where the array length of ids should be stored * \param[out] ppArray Array where the surface id should be stored, @@ -172,7 +166,7 @@ ilmErrorTypes ilm_getSurfaceIDsOnLayer(t_ilm_layer layer,t_ilm_int* pLength,t_il /** * \brief Create a layer which should be managed by the service * \deprecated Will be removed in later version please use ilm_layerCreateWithDimension - * \ingroup Layer + * \ingroup ilmClient * \param[out] pLayerId pointer where the id should be/is stored. It is possible * to set a id from outside, 0 will create a new id. * \return ILM_TRUE if the method call was successful @@ -182,7 +176,7 @@ ilmErrorTypes ilm_layerCreate(t_ilm_layer* pLayerId); /** * \brief Create a layer which should be managed by the service - * \ingroup Layer + * \ingroup ilmClient * \param[out] pLayerId pointer where the id should be/is stored. It is possible * to set a id from outside, 0 will create a new id. *\param[in] width horizontal dimension of the layer @@ -197,7 +191,7 @@ ilmErrorTypes ilm_layerCreateWithDimension(t_ilm_layer* pLayerId, t_ilm_uint wid /** * \brief Removes a layer which is currently managed by the service - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Layer to be removed * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. @@ -206,7 +200,7 @@ ilmErrorTypes ilm_layerRemove(t_ilm_layer layerId); /** * \brief Add a surface to a layer which is currently managed by the service - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer which should host the surface. * \param[in] surfaceId Id of surface which should be added to the layer. * \return ILM_TRUE if the method call was successful @@ -216,7 +210,7 @@ ilmErrorTypes ilm_layerAddSurface(t_ilm_layer layerId, t_ilm_surface surfaceId); /** * \brief Removes a surface from a layer which is currently managed by the service - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer which contains the surface. * \param[in] surfaceId Id of the surface which should be removed from the layer. * \return ILM_TRUE if the method call was successful @@ -226,7 +220,7 @@ ilmErrorTypes ilm_layerRemoveSurface(t_ilm_layer layerId, t_ilm_surface surfaceI /** * \brief Get the current type of the layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer. * \param[out] pLayerType pointer to the layerType where the result should be stored. * \note ilmLayerType for information on supported types @@ -238,7 +232,7 @@ ilmErrorTypes ilm_layerGetType(t_ilm_layer layerId, ilmLayerType* pLayerType); /** * \brief Set the visibility of a layer. If a layer is not visible, the layer and its * surfaces will not be rendered. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer. * \param[in] newVisibility ILM_TRUE sets layer visible, ILM_FALSE disables the visibility. * \return ILM_TRUE if the method call was successful @@ -249,7 +243,7 @@ ilmErrorTypes ilm_layerSetVisibility(t_ilm_layer layerId, t_ilm_bool newVisibili /** * \brief Get the visibility of a layer. If a layer is not visible, the layer and its * surfaces will not be rendered. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[out] pVisibility pointer where the visibility of the layer should be stored * ILM_TRUE if the Layer is visible, @@ -261,7 +255,7 @@ ilmErrorTypes ilm_layerGetVisibility(t_ilm_layer layerId,t_ilm_bool *pVisibility /** * \brief Set the opacity of a layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer. * \param[in] opacity 0.0 means the layer is fully transparent, * 1.0 means the layer is fully opaque @@ -272,7 +266,7 @@ ilmErrorTypes ilm_layerSetOpacity(t_ilm_layer layerId, t_ilm_float opacity); /** * \brief Get the opacity of a layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer to obtain the opacity of. * \param[out] pOpacity pointer where the layer opacity should be stored. * 0.0 means the layer is fully transparent, @@ -284,7 +278,7 @@ ilmErrorTypes ilm_layerGetOpacity(t_ilm_layer layerId, t_ilm_float *pOpacity); /** * \brief Set the area of a layer which should be used for the rendering. Only this part will be visible. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer. * \param[in] x horizontal start position of the used area * \param[in] y vertical start position of the used area @@ -297,7 +291,7 @@ ilmErrorTypes ilm_layerSetSourceRectangle(t_ilm_layer layerId, t_ilm_uint x, t_i /** * \brief Set the destination area on the display for a layer. The layer will be scaled and positioned to this rectangle for rendering - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer. * \param[in] x horizontal start position of the used area * \param[in] y vertical start position of the used area @@ -310,7 +304,7 @@ ilmErrorTypes ilm_layerSetDestinationRectangle(t_ilm_layer layerId, t_ilm_int x, /** * \brief Get the horizontal and vertical dimension of the layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[out] pDimension pointer to an array where the dimension should be stored. * dimension[0]=width, dimension[1]=height @@ -321,7 +315,7 @@ ilmErrorTypes ilm_layerGetDimension(t_ilm_layer layerId, t_ilm_uint *pDimension) /** * \brief Set the horizontal and vertical dimension of the layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[in] pDimension pointer to an array where the dimension is stored. * dimension[0]=width, dimension[1]=height @@ -332,7 +326,7 @@ ilmErrorTypes ilm_layerSetDimension(t_ilm_layer layerId, t_ilm_uint *pDimension) /** * \brief Get the horizontal and vertical position of the layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[out] pPosition pointer to an array where the position should be stored. * dimension[0]=width, dimension[1]=height @@ -343,7 +337,7 @@ ilmErrorTypes ilm_layerGetPosition(t_ilm_layer layerId, t_ilm_uint *pPosition); /** * \brief Sets the horizontal and vertical position of the layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[in] Pposition pointer to an array where the position is stored. * dimension[0]=x, dimension[1]=y @@ -354,7 +348,7 @@ ilmErrorTypes ilm_layerSetPosition(t_ilm_layer layerId, t_ilm_uint *pPosition); /** * \brief Sets the orientation of a layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[in] orientation Orientation of the layer. * \note ilmOrientation for more information on orientation values @@ -365,7 +359,7 @@ ilmErrorTypes ilm_layerSetOrientation(t_ilm_layer layerId, ilmOrientation orient /** * \brief Gets the orientation of a layer. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[out] pOrientation Address where orientation of the layer should be stored. * \note ilmOrientation for more information on orientation values @@ -376,7 +370,7 @@ ilmErrorTypes ilm_layerGetOrientation(t_ilm_layer layerId, ilmOrientation *pOrie /** * \brief Sets the color value which defines the transparency value. - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[in] pColor array of the color value which is defined in red,green, blue * \todo This method is currently not implemented. @@ -387,7 +381,7 @@ ilmErrorTypes ilm_layerSetChromaKey(t_ilm_layer layerId, t_ilm_int* pColor); /** * \brief Sets render order of surfaces within one layer - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of layer. * \param[in] pSurfaceId array of surface ids * \param[in] number Number of elements in the given array of ids @@ -398,7 +392,7 @@ ilmErrorTypes ilm_layerSetRenderOrder(t_ilm_layer layerId, t_ilm_layer *pSurface /** * \brief Get the capabilities of a layer - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerId Id of the layer to obtain the capabilities of * \param[out] pCapabilities The address where the capabilites are returned * \return ILM_TRUE if the method call was successful @@ -408,7 +402,7 @@ ilmErrorTypes ilm_layerGetCapabilities(t_ilm_layer layerId, t_ilm_layercapabilit /** * \brief Get the possible capabilities of a layertype - * \ingroup Layer + * \ingroup ilmClient * \param[in] layerType The layertype to obtain the capabilities of * \param[out] pCapabilities The address where the capabilites are returned * \return ILM_TRUE if the method call was successful @@ -418,7 +412,7 @@ ilmErrorTypes ilm_layerTypeGetCapabilities(ilmLayerType layerType, t_ilm_layerca /** * \brief Create a layergroup - * \ingroup LayerGroup + * \ingroup ilmClient * \param[out] pLayergroup The id of the created layergroup is returned in this parameter * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. @@ -427,7 +421,7 @@ ilmErrorTypes ilm_layergroupCreate(t_ilm_layergroup *pLayergroup); /** * \brief Remove a layergroup - * \ingroup LayerGroup + * \ingroup ilmClient * \param[in] layergroup The layergroup to be removed * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. @@ -436,7 +430,7 @@ ilmErrorTypes ilm_layergroupRemove(t_ilm_layergroup layergroup); /** * \brief Add a layer to a layergroup - * \ingroup LayerGroup + * \ingroup ilmClient * \param[in] group The layergroup to add the layer * \param[in] layer The layer to add to the group * \return ILM_TRUE if the method call was successful @@ -446,7 +440,7 @@ ilmErrorTypes ilm_layergroupAddLayer(t_ilm_layergroup group, t_ilm_layer layer); /** * \brief Remove a layer from a layergroup - * \ingroup LayerGroup + * \ingroup ilmClient * \param[in] layergroup The layergroup to remove the layer from * \param[in] layer The layer to be removed from the group * @@ -459,7 +453,7 @@ ilmErrorTypes ilm_layergroupRemoveLayer(t_ilm_layergroup layergroup, t_ilm_layer /** * \brief Set the visibility of a layergroup. If a layergroup is not visible, the layers and their * surfaces will not be rendered. - * \ingroup LayerGroup + * \ingroup ilmClient * \param[in] layergroup Id of the layergroup to set the visibility of * \param[in] newVisibility ILM_TRUE sets layergroup visible, ILM_FALSE disables the visibility. * \return ILM_TRUE if the method call was successful @@ -469,7 +463,7 @@ ilmErrorTypes ilm_layergroupSetVisibility(t_ilm_layergroup layergroup, t_ilm_boo /** * \brief Set the opacity of a layergroup. - * \ingroup LayerGroup + * \ingroup ilmClient * \param[in] group Id of the layergroup to set the opacity of. * \param[in] opacity 0.0 means the layergroup is fully transparent, * 1.0 means the layergroup is fully opaque @@ -480,7 +474,7 @@ ilmErrorTypes ilm_layergroupSetOpacity(t_ilm_layergroup group, t_ilm_float opaci /** * \brief Create a surface - * \ingroup Surface + * \ingroup ilmClient * \param[in] nativehandle The native windowsystem's handle for the surface * \param[in] width The original width of the surface * \param[in] height The original height of the surface @@ -496,7 +490,7 @@ ilmErrorTypes ilm_surfaceCreate(t_ilm_nativehandle nativehandle, t_ilm_int width /** * \brief Create the logical surface, which has no native buffer associated - * \ingroup Surface + * \ingroup ilmClient * \param[in/out] pSurfaceId * The value pSurfaceId points to is used as ID for new surface; * The ID of the newly created surface is returned in this parameter @@ -507,7 +501,7 @@ ilmErrorTypes ilm_surfaceInitialize(t_ilm_surface *pSurfaceId); /** * \brief Set the native content of an application to be used as surface content - * \ingroup Surface + * \ingroup ilmClient * \param[in] nativehandle The native windowsystem's handle for the surface * \param[in] width The original width of the surface * \param[in] height The original height of the surface @@ -520,7 +514,7 @@ ilmErrorTypes ilm_surfaceSetNativeContent(t_ilm_nativehandle nativehandle, t_ilm /** * \brief Remove a surface - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId The id of the surface to be removed * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. @@ -529,7 +523,7 @@ ilmErrorTypes ilm_surfaceRemove(const t_ilm_surface surfaceId); /** * \brief Set the visibility of a surface. If a surface is not visible it will not be rendered. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of the surface to set the visibility of * \param[in] newVisibility ILM_TRUE sets surface visible, ILM_FALSE disables the visibility. * \return ILM_TRUE if the method call was successful @@ -540,7 +534,7 @@ ilmErrorTypes ilm_surfaceSetVisibility(t_ilm_surface surfaceId, t_ilm_bool newVi /** * \brief Get the visibility of a surface. If a surface is not visible, the surface * will not be rendered. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of the surface to get the visibility of. * \param[out] pVisibility pointer where the visibility of a surface should be stored * ILM_TRUE if the surface is visible, @@ -552,7 +546,7 @@ ilmErrorTypes ilm_surfaceGetVisibility(t_ilm_surface surfaceId, t_ilm_bool *pVis /** * \brief Set the opacity of a surface. - * \ingroup Surface + * \ingroup ilmClient * \param surfaceId Id of the surface to set the opacity of. * \param opacity 0.0 means the surface is fully transparent, * 1.0 means the surface is fully opaque @@ -563,7 +557,7 @@ ilmErrorTypes ilm_surfaceSetOpacity(const t_ilm_surface surfaceId, t_ilm_float o /** * \brief Get the opacity of a surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of the surface to get the opacity of. * \param[out] pOpacity pointer where the surface opacity should be stored. * 0.0 means the surface is fully transparent, @@ -575,7 +569,7 @@ ilmErrorTypes ilm_surfaceGetOpacity(const t_ilm_surface surfaceId, t_ilm_float * /** * \brief Set the area of a surface which should be used for the rendering. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[in] x horizontal start position of the used area * \param[in] y vertical start position of the used area @@ -588,7 +582,7 @@ ilmErrorTypes ilm_surfaceSetSourceRectangle(t_ilm_surface surfaceId, t_ilm_int x /** * \brief Set the destination area of a surface within a layer for rendering. The surface will be scaled to this rectangle for rendering. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[in] x horizontal start position of the used area * \param[in] y vertical start position of the used area @@ -601,7 +595,7 @@ ilmErrorTypes ilm_surfaceSetDestinationRectangle(t_ilm_surface surfaceId, t_ilm_ /** * \brief Get the horizontal and vertical dimension of the surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[out] pDimension pointer to an array where the dimension should be stored. * dimension[0]=width, dimension[1]=height @@ -614,7 +608,7 @@ ilmErrorTypes ilm_surfaceGetDimension(t_ilm_surface surfaceId, t_ilm_uint *pDime /** * \brief Set the horizontal and vertical dimension of the surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[in] pDimension pointer to an array where the dimension is stored. * dimension[0]=width, dimension[1]=height @@ -625,7 +619,7 @@ ilmErrorTypes ilm_surfaceSetDimension(t_ilm_surface surfaceId, t_ilm_uint *pDime /** * \brief Get the horizontal and vertical position of the surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[out] pPosition pointer to an array where the position should be stored. * position[0]=x, position[1]=y @@ -636,7 +630,7 @@ ilmErrorTypes ilm_surfaceGetPosition(t_ilm_surface surfaceId, t_ilm_uint *pPosit /** * \brief Sets the horizontal and vertical position of the surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[in] pPosition pointer to an array where the position is stored. * position[0]=x, position[1]=y @@ -647,7 +641,7 @@ ilmErrorTypes ilm_surfaceSetPosition(t_ilm_surface surfaceId, t_ilm_uint *pPosit /** * \brief Sets the orientation of a surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[in] orientation Orientation of the surface. * \note ilmOrientation for information about orientation values @@ -658,7 +652,7 @@ ilmErrorTypes ilm_surfaceSetOrientation(t_ilm_surface surfaceId, ilmOrientation /** * \brief Gets the orientation of a surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[out] pOrientation Address where orientation of the surface should be stored. * \note ilmOrientation for information about orientation values @@ -669,7 +663,7 @@ ilmErrorTypes ilm_surfaceGetOrientation(t_ilm_surface surfaceId, ilmOrientation /** * \brief Gets the pixelformat of a surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of surface. * \param[out] pPixelformat Pointer where the pixelformat of the surface should be stored * \note ilmPixelFormat for information about pixel format values @@ -680,7 +674,7 @@ ilmErrorTypes ilm_surfaceGetPixelformat(t_ilm_layer surfaceId, ilmPixelFormat *p /** * \brief Sets the color value which defines the transparency value of a surface. - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of the surface to set the chromakey of. * \param[in] pColor array of the color value which is defined in red, green, blue * \todo This method is currently not implemented. @@ -691,7 +685,7 @@ ilmErrorTypes ilm_surfaceSetChromaKey(t_ilm_surface surfaceId, t_ilm_int* pColor /** * \brief Inform that a certain rectangle of a surface has been invalidated and must consequently be redrawn - * \ingroup Surface + * \ingroup ilmClient * \param[in] surfaceId Id of the surface * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. @@ -700,7 +694,7 @@ ilmErrorTypes ilm_surfaceInvalidateRectangle(t_ilm_surface surfaceId); /** * \brief Create a surfacegroup - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[in] pSurfacegroup The created surfacegroup is returned in this parameter * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. @@ -709,7 +703,7 @@ ilmErrorTypes ilm_surfacegroupCreate(t_ilm_surfacegroup *pSurfacegroup); /** * \brief Remove a surfacegroup - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[in] surfacegroup The surfacegroup to be removed * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. @@ -718,7 +712,7 @@ ilmErrorTypes ilm_surfacegroupRemove(t_ilm_surfacegroup surfacegroup); /** * \brief Add a surface to a surfacegroup - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[in] surfacegroup The surfacegroup to add the surface * \param[in] surface The surface to add to the group * \return ILM_TRUE if the method call was successful @@ -728,7 +722,7 @@ ilmErrorTypes ilm_surfacegroupAddSurface(t_ilm_surfacegroup surfacegroup, t_ilm_ /** * \brief Remove a surface from a surfacegroup - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[in] surfacegroup The surfacegroup to remove the surface from * \param[in] surface The surface to be removed from the group * \return ILM_TRUE if the method call was successful @@ -739,7 +733,7 @@ ilmErrorTypes ilm_surfacegroupRemoveSurface(t_ilm_surfacegroup surfacegroup, t_i /** * \brief Set the visibility of a surfacegroup. If a surfacegroup is not visible the contained * surfaces will not be rendered. - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[in] surfacegroup Id of the surfacegroup to set the visibility of * \param[in] newVisibility ILM_TRUE sets surfacegroup visible, ILM_FALSE disables the visibility. * \return ILM_TRUE if the method call was successful @@ -749,7 +743,7 @@ ilmErrorTypes ilm_surfacegroupSetVisibility(t_ilm_surfacegroup surfacegroup, t_i /** * \brief Set the opacity of a surfacegroup. - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[in] surfacegroup Id of the surfacegroup to set the opacity of. * \param[in] opacity 0.0 means the surfacegroup is fully transparent, * 1.0 means the surfacegroup is fully opaque @@ -760,7 +754,7 @@ ilmErrorTypes ilm_surfacegroupSetOpacity(t_ilm_surfacegroup surfacegroup, t_ilm_ /** * \brief Sets render order of layers on a display - * \ingroup SurfaceGroup + * \ingroup ilmClient * \param[in] display Id of display to set the given order of layers. * \param[in] pLayerId array of layer ids * \param[in] number number of layerids in the given array @@ -772,7 +766,7 @@ ilmErrorTypes ilm_displaySetRenderOrder(t_ilm_display display, t_ilm_layer *pLay /** * \brief Take a screenshot from the current displayed layer scene. * The screenshot is saved as bmp file with the corresponding filename. - * \ingroup Screen + * \ingroup ilmClient * \param[in] screen Id of screen where screenshot should be taken * \param[in] filename Location where the screenshot should be stored * \return ILM_TRUE if the method call was successful @@ -783,7 +777,7 @@ ilmErrorTypes ilm_takeScreenshot(t_ilm_uint screen, t_ilm_const_string filename) /** * \brief Take a screenshot of a certain layer * The screenshot is saved as bmp file with the corresponding filename. - * \ingroup Layer + * \ingroup ilmClient * \param[in] filename Location where the screenshot should be stored * \param[in] layerid Identifier of the layer to take the screenshot of * \return ILM_TRUE if the method call was successful @@ -794,7 +788,7 @@ ilmErrorTypes ilm_takeLayerScreenshot(t_ilm_const_string filename, t_ilm_layer l /** * \brief Take a screenshot of a certain surface * The screenshot is saved as bmp file with the corresponding filename. - * \ingroup Surface + * \ingroup ilmClient * \param[in] filename Location where the screenshot should be stored * \param[in] surfaceid Identifier of the surface to take the screenshot of * \return ILM_TRUE if the method call was successful @@ -804,7 +798,7 @@ ilmErrorTypes ilm_takeSurfaceScreenshot(t_ilm_const_string filename, t_ilm_surfa /** * \brief Commit all changes and executed commands since last commit. - * \ingroup LifeCycleManagement + * \ingroup ilmClient * \return ILM_TRUE if the method call was successful * \return ILM_FAILED if the client can not call the method on the service. */ -- 2.7.4