2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
14 * Description: Internal binding API for OpenVG, used for managing OpenVG rendering contexts.
17 #ifndef _OPENVG_CONTEXT_H
18 #define _OPENVG_CONTEXT_H
20 #include <VG/openvg.h>
23 Implementation note: all VGI_ERROR_xxx should be negative and well below standard Symbian error codes!
27 VGI_ERROR_OUT_OF_MEMORY = (-10000),
28 VGI_ERROR_INVALID_ARGUMENTS = (-10001),
29 VGI_ERROR_ALREADY_EXISTS = (-10002),
30 VGI_ERROR_COLORSPACE_NOT_SUPPORTED = (-10003),
31 VGI_ERROR_NOT_SUPPORTED = (-10004),
32 VGI_ERROR_ILLEGAL_IMAGE_HANDLE = (-10005),
33 VGI_ERROR_IMAGE_IN_USE = (-10006),
34 VGI_ERROR_ILLEGAL_OPERATION = (-10007),
38 VGI_COLORSPACE_LINEAR,
43 VGI_COLOR_BUFFER_FORMAT_RGB565,
44 VGI_COLOR_BUFFER_FORMAT_RGB888,
45 VGI_COLOR_BUFFER_FORMAT_XRGB8888,
46 VGI_COLOR_BUFFER_FORMAT_ARGB8888,
47 VGI_COLOR_BUFFER_FORMAT_ARGB8888_PRE,
48 VGI_COLOR_BUFFER_FORMAT_XRGB4444,
49 } VGIColorBufferFormat;
52 VGI_SKIP_TRANSPARENT_PIXELS,
53 VGI_COPY_TRANSPARENT_PIXELS,
54 } VGICopyToTargetHint;
56 #ifdef GRAPHICS_LIBVGI_DLL
57 #define VGI_API_CALL __declspec(dllexport)
59 #define VGI_API_CALL __declspec(dllimport)
67 * OpenVG is initialized with the selected size and colorspace. A single rendering context is created and
68 * made active (there is no support for multiple contexts). Single rendering (back buffer) surface is created
69 * by OpenVG and made active for Read and Write.
70 * @param width of the rendering surface (back buffer) size in pixels.
71 * @param height of the rendering surface (back buffer) size in pixels.
72 * @param colorSpace space to be used. Must be either VGI_COLORSPACE_LINEAR or VGI_COLORSPACE_SRGB.
73 * @return Returns VGI_OK if initialization was successful. Returns error code VGI_ERROR_INVALID_ARGUMENTS
74 * if width or height are negative. Returns error code VGI_ERROR_OUT_OF_MEMORY if there is insufficient
75 * free memory to complete the initialization (smaller size for back buffer or smaller antialiasing setting may
76 * work). Returns error code VGI_ERROR_ALREADY_EXISTS if the surface and context already exists in this
77 * process & thread (call VGITerminate to reset). Returns error code VGI_ERROR_COLORSPACE_NOT_SUPPORTED
78 * if the given colorspace is not supported by the implementation.
80 VGI_API_CALL int VGIInitialize( int width, int height, VGIColorSpace colorSpace );
83 * OpenVG is initialized with the selected size and colorspace. A single rendering context is created and
84 * made active (there is no support for multiple contexts). Single rendering (back buffer) surface is created
85 * by OpenVG and made active for Read and Write.
86 * @param width of the rendering surface (back buffer) size in pixels.
87 * @param height of the rendering surface (back buffer) size in pixels.
88 * @param colorSpace space to be used. Must be either VGI_COLORSPACE_LINEAR or VGI_COLORSPACE_SRGB.
89 * @param premultiplied flag indicates whether to create a premultiplied or non-premultiplied rendering surface.
90 * @return Returns VGI_OK if initialization was successful. Returns error code VGI_ERROR_INVALID_ARGUMENTS
91 * if width or height are negative. Returns error code VGI_ERROR_OUT_OF_MEMORY if there is insufficient
92 * free memory to complete the initialization (smaller size for back buffer or smaller antialiasing setting may
93 * work). Returns error code VGI_ERROR_ALREADY_EXISTS if the surface and context already exists in this
94 * process & thread (call VGITerminate to reset). Returns error code VGI_ERROR_COLORSPACE_NOT_SUPPORTED
95 * if the given colorspace is not supported by the implementation.
97 VGI_API_CALL int VGIInitializeEx( int width, int height, VGIColorSpace colorSpace, int premultiplied, int conformant );
100 * Copies the current contents of the internal back buffer to the given target buffer using the given stride
101 * and format. Back buffer contents may be undefined after this function as it marks the start of new frame.
102 * All target formats are supported by all implementations and the format bit pattern definitions match the
103 * Symbian formats (EColo64K, EColor16M, EColor16MU, EColor16MA). Target buffer memory is assumed to be generic
104 * system memory (MMU mapped).
105 * @param format Format that is to be used when writing data to the given target buffer. Must be one of the
106 * VGI_COLOR_BUFFER_FORMAT_xxx values.
107 * @param bufferStride Amount of bytes from beginning of scanline to the beginning of the next.
108 * Do NOT assume that width * bpp always equals stride!
109 * @param buffer Target buffer where the current back buffer is copied to.
110 * The implementation uses internal back buffer and this target buffer is used only
111 * during the execution of this method.
112 * @param maskStride Amount of bytes from beginning of scanline to the beginning of the next
113 * in the target mask buffer. Do NOT assume that width * bpp always equals stride!
114 * @param mask Target buffer for the 8-bits per pixel destination alpha output
115 * (only written to by the method if parameter is not NULL and format is other than VGI_BUFFER_FORMAT_ARGB8888)
116 * @param hint Specify how to process transparent pixels.
117 * Value VGI_SKIP_TRANSPARENT_PIXELS means transparent pixels are not copied to the target buffer.
118 * Value VGI_COPY_TRANSPARENT_PIXELS means every pixel transparent or not is copied to the target buffer.
119 * @return Returns VGI_OK if copying completed successfully. Returns error code VGI_ERROR_INVALID_ARGUMENTS
120 * if bufferStride or maskStride are negative, if target buffer is either NULL or is not properly aligned. if
121 * the format is invalid or if hint is neither VGI_SKIP_TRANSPARENT_PIXELS nor VGI_COPY_TRANSPARENT_PIXELS.
122 * Returns error code VGI_ERROR_OUT_OF_MEMORY if there is insufficient
123 * free memory to complete the copying (before returning this error code the implementation internally
124 * calls VGITerminate() and current context and surface are lost.
126 VGI_API_CALL int VGICopyToTarget( VGIColorBufferFormat format, int bufferStride, void *buffer, int maskStride, void *mask, VGICopyToTargetHint hint );
129 * Rendering surface and context are freed and may not be used after call to this method. OpenVG is terminated (all
130 * other related resources are freed). If this method is called before VGIInitialize, or VGITerminate is called after
131 * already being called, this method does nothing. In other words it is safe to call VGITerminate() multiple times
134 VGI_API_CALL void VGITerminate( void );
137 * Resizes the back buffer to have the given width and height . This method should always be used to resize the back buffer as in
138 * many implementations the resize operation can be handled more efficiently than a plain delete old, create new method.
139 * Old context is preserved and can be used after the resize operation. Contents of the new frame buffer are UNDEFINED.
140 * @param width Width of the back buffer after resize operation.
141 * @param height Height of the back buffer after resize operation.
142 * @return Returns VGI_OK if resize operation was successful. Returns error code VGI_ERROR_ILLEGAL_OPERATION if an image is currently
143 * set as the render target. Returns error code VGI_ERROR_INVALID_ARGUMENTS if width
144 * or height are negative or error code VGI_ERROR_OUT_OF_MEMORY if there is insufficient free memory to allocate the back
145 * buffer of given size (smaller size may work).
146 * @note: if VGI_ERROR_OUT_OF_MEMORY is returned, the original surface is lost and VGITerminate is called internally (context & surface is lost)
148 VGI_API_CALL int VGIResize( int width, int height );
151 * Redirects rendering to an image.
152 * @param image Image to be set as the render target.
153 * @return Returns VGI_OK if successful.
154 * Returns error code VGI_ERROR_ILLEGAL_IMAGE_HANDLE if image is not a valid image handle, or is not shared with the current context.
155 * Returns error code VGI_ERROR_NOT_SUPPORTED if image is not of the same format as the "master surface".
156 * Returns error code VGI_ERROR_IMAGE_IN_USE if image shares storage with any other image (via use of the vgChildImage function),
157 * or is set as a paint pattern image on a paint object.
158 * Returns error code VGI_ERROR_OUT_OF_MEMORY if there is insufficient free memory to perform the operation.
159 * @note: if VGI_ERROR_OUT_OF_MEMORY is returned, the original surface is lost and VGITerminate is called internally (context & surface is lost)
161 VGI_API_CALL int VGIBindToImage( VGImage image );
164 * Reset the "master surface" as current render target .
165 * @return Returns VGI_OK if successful.
166 * Returns error code VGI_ERROR_OUT_OF_MEMORY if there is insufficient free memory to perform the operation.
167 * @note: if VGI_ERROR_OUT_OF_MEMORY is returned, the original surface is lost and VGITerminate is called internally (context & surface is lost)
169 VGI_API_CALL int VGIUnBindImage( void );
175 #endif /* _OPENVG_CONTEXT_H */