1 /*************************************************************************** 2 * 3 * Copyright 2010,2011 BMW Car IT GmbH 4 * Copyright (c) 2012, NVIDIA CORPORATION. All rights reserved. 5 * 6 * 7 * Licensed under the Apache License, Version 2.0 (the "License"); 8 * you may not use this file except in compliance with the License. 9 * You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, software 14 * distributed under the License is distributed on an "AS IS" BASIS, 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 * See the License for the specific language governing permissions and 17 * limitations under the License. 18 * 19 ****************************************************************************/ 20 #ifndef _ILM_CLIENT_H_ 21 #define _ILM_CLIENT_H_ 22 23 #ifdef __cplusplus 24 25 extern "C" { 26 #endif /* __cplusplus */ 27 28 #include "ilm_common.h" 29 30 /** 31 * \brief Initializes the IVI LayerManagement Client APIs. 32 * \ingroup ilmControl 33 * \param[in] nativedisplay the wl_display of native application 34 * \return ILM_SUCCESS if the method call was successful 35 * \return ILM_FAILED if a connection can not be established to the services. 36 */ 37 ilmErrorTypes ilmClient_init(t_ilm_nativedisplay nativedisplay) ILM_DEPRECATED; 38 39 /** 40 * \brief Create a surface 41 * \ingroup ilmClient 42 * \param[in] nativehandle The native windowsystem's handle for the surface 43 * \param[in] width The original width of the surface 44 * \param[in] height The original height of the surface 45 * \param[in] pixelFormat The pixelformat to be used for the surface 46 * \param[in] pSurfaceId The value pSurfaceId points to is used as ID for new surface; 47 * \param[out] pSurfaceId The ID of the newly created surface is returned in this parameter 48 * 49 * \return ILM_SUCCESS if the method call was successful 50 * \return ILM_FAILED if the client can not call the method on the service. 51 */ 52 ilmErrorTypes ilm_surfaceCreate(t_ilm_nativehandle nativehandle, 53 t_ilm_int width, 54 t_ilm_int height, 55 ilmPixelFormat pixelFormat, 56 t_ilm_surface *pSurfaceId) ILM_DEPRECATED; 57 58 /** 59 * \brief Remove a surface 60 * \ingroup ilmClient 61 * \param[in] surfaceId The id of the surface to be removed 62 * \return ILM_SUCCESS if the method call was successful 63 * \return ILM_FAILED if the client can not call the method on the service. 64 */ 65 ilmErrorTypes ilm_surfaceRemove(const t_ilm_surface surfaceId) ILM_DEPRECATED; 66 67 /** 68 * \brief Destroys the IVI LayerManagement Client APIs. 69 * \ingroup ilmCommon 70 * \return ILM_SUCCESS if the method call was successful 71 * \return ILM_FAILED if the client can not be closed or was not initialized. 72 */ 73 ilmErrorTypes ilmClient_destroy(void) ILM_DEPRECATED; 74 75 #ifdef __cplusplus 76 } /**/ 77 #endif /* __cplusplus */ 78 79 #endif /* _ILM_CLIENT_H_ */ 80