Copyright (C) 2013 DENSO CORPORATION Copyright (c) 2013 BMW Car IT GmbH Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. If visibility argument is 0, the surface in the ivi compositor is set to invisible. If visibility argument is not 0, the surface in the ivi compositor is set to visible. The valid range for opacity is 0.0 (fully transparent) to 1.0 (fully opaque). The source rectangle defines the part of the surface content, that is used for compositing the surface. It can be used, if valid content of the surface is smaller than the surface. Effectively it can be used to zoom the content of the surface. x: horizontal start position of scanout area within the surface y: vertical start position of scanout area within the surface width: width of scanout area within the surface height: height of scanout area within the surface The destination rectangle defines the position and size of a surface on a layer. The surface will be scaled to this rectangle for rendering. x: horizontal start position of surface within the layer y: vertical start position of surface within the layer width : width of surface within the layer height: height of surface within the layer Request the client providing content for this surface, to resize of the buffers provided as surface content. The orientation of a surface in ivi compositor can be rotated in 90 degree steps, as defined in orientation enum. Store a screenshot of the surface content in the file provided by argument filename. The new visibility state is provided in argument visibility. If visibility is 0, the surface has become invisible. If visibility is not 0, the surface has
agl-speech-framework
="request statistics for surface in ivi compositor"> These stats contain information required for monitoring, debugging, logging and tracing. The information contained in this event is essential for monitoring, debugging, logging and tracing support in IVI systems. Request to destroy the ivi_controller_surface. If argument destroy_scene_object id not 0, the surface will be destroyed in ivi compositor. If argument is 0, only the proxy object is destroyed. This enum defines all possible content states of a surface. This is required, since surfaces in ivi compositor can exist without applications providing content for them. Surfaces in ivi compositor can exist without any application or controller referencing it. All surfaces initially have no content. This event indicates when content state has changed. All possible content states are defined in enum content_state. If visibility argument is 0, the layer in the ivi compositor is set to invisible. If visibility argument is not 0, the layer in the ivi compositor is set to visible. The valid range for opacity is 0.0 (fully transparent) to 1.0 (fully opaque). The source rectangle defines the part of the layer content, that is used for compositing the screen. It can be used, if valid content of the layer is smaller than the layer. Effectively it can be used to zoom the content of the layer. x: horizontal start position of scanout area within the layer y: vertical start position of scanout area within the layer width: width of scanout area within the layer height: height of scanout area within the layer The destination rectangle defines the position and size of a layer on a screen. The layer will be scaled to this rectangle for rendering. x: horizontal start position of layer within the screen y: vertical start position of layer within the screen width : width of surface within the screen height: height of surface within the screen Layers are created with an initial size, but they can be resized at runtime. This request changes the widht and height of a layer. The orientation of a layer in ivi compositor can be rotated in 90 degree steps, as defined in orientation enum. Store a screenshot of the layer content in the file provided by argument filename. A layer has no content assigned to itself, it is a container for surfaces. This request removes all surfaces from the layer render order. Note: the surfaces are not destroyed, they are just no longer contained by the layer. A layer has no content assigned to itself, it is a container for surfaces. This request adds a surface to the topmost position of the layer render order. The added surface will cover all other surfaces of the layer. A layer has no content assigned to itself, it is a container for surfaces. This request removes one surfaces from the layer render order. Note: the surface is not destroyed, it is just no longer contained by the layer. A layer has no content assigned to itself, it is a container for surfaces. This request removes all surfaces from the layer render order and set a completely new render order. The new visibility state is provided in argument visibility. If visibility is 0, the layer has become invisible. If visibility is not 0, the layer has become visible. The new opacity state is provided in argument opacity. The valid range for opactiy is 0.0 (fully transparent) to 1.0 (fully opaque). The scanout region of the layer content has changed. The new values for source rectangle are provided by x: new horizontal start position of scanout area within the layer y: new vertical start position of scanout area within the layer width: new width of scanout area within the layer height: new height of scanout area within the layer The new values for source rectangle are provided by x: new horizontal start position of layer within the screen y: new vertical start position of layer within the screen width : new width of layer within the screen height: new height of layer within the screen The layer was resized. The new layer size is provided by arguments width and height. The new orientation status is provided by argument orientation. This layer was added to the render order of the screen defined by argument screen. This is essential for a layer to become visible on screen, since ivi compositors will only render screens (or more precise all layers in the render order of a screen). Request to destroy the ivi_controller_layer. If argument destroy_scene_object id not 0, the layer will be destroyed in ivi compositor. If argument is 0, only the proxy object is destroyed. A screen has no content assigned to itself, it is a container for layers. This request removes all layers from the screen render order. Note: the layers are not destroyed, they are just no longer contained by the screen. A screen has no content assigned to itself, it is a container for layers. This request adds a layers to the topmost position of the screen render order. The added layer will cover all other layers of the screen. Store a screenshot of the screen content in the file provided by argument filename. A screen has no content assigned to itself, it is a container for layers. This request removes all layers from the screen render order and set a completely new render order. All requests are not applied directly to scene object, so a controller can set different properties and apply the changes all at once. Note: there's an exception to this. Creation and destruction of scene objects is executed immediately. A new screen is announced to the controller. This is typically the case in two cases: 1. controller was just started, ivi compositor announces existing screen 2. a new screen was added to the system at runtime layer_create will create a new layer with id_layer in ivi compositor, if it does not yet exists. If the layer with id_layer already exists in ivi compositor, a handle to the existing layer is returned and width and height properties are ignored. A new layer is announced to the controller. surface_create will create a new surface with id_surface in ivi compositor, if it does not yet exists. If the surface with id_surface already exists in ivi compositor, a handle to the existing surface is returned. A new surface is announced to the controller. This enum defines all scene object available in ivi compositor. These error codes define all possible error codes returned by ivi compositor on server-side errors. The ivi compositor encountered error while processing a request by this controller. The error is defined by argument error_code and optional error_text. Additionally the object type and id is contained in the error event to provide some detailes to handle the error. If the controller requires to associate this error event to a request, it can 1. send request 2. force display roundtrip 3. check, if error event was received but this restricts the controller to have only one open request at a time.