doc/cairo-evas-gl_doc.h

   1 /* Cairo - a vector graphics library with display and print output
   2  *
   3  * Copyright © 2009 Eric Anholt
   4  * Copyright © 2009 Chris Wilson
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it either under the terms of the GNU Lesser General Public
   8  * License version 2.1 as published by the Free Software Foundation
   9  * (the "LGPL") or, at your option, under the terms of the Mozilla
  10  * Public License Version 1.1 (the "MPL"). If you do not alter this
  11  * notice, a recipient may use your version of this file under either
  12  * the MPL or the LGPL.
  13  *
  14  * You should have received a copy of the LGPL along with this library
  15  * in the file COPYING-LGPL-2.1; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA
  17  * You should have received a copy of the MPL along with this library
  18  * in the file COPYING-MPL-1.1
  19  *
  20  * The contents of this file are subject to the Mozilla Public License
  21  * Version 1.1 (the "License"); you may not use this file except in
  22  * compliance with the License. You may obtain a copy of the License at
  23  * http://www.mozilla.org/MPL/
  24  *
  25  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
  26  * OF ANY KIND, either express or implied. See the LGPL or the MPL for
  27  * the specific language governing rights and limitations.
  28  *
  29  * The Original Code is the cairo graphics library.
  30  *
  31  * The Initial Developer of the Original Code is Eric Anholt.
  32  */
  33
  34 #ifndef __TIZEN_CAIRO_EVAS_GL_DOC_H__
  35 #define __TIZEN_CAIRO_EVAS_GL_DOC_H__
  36
  37 /**
  38  * @defgroup CAPI_CAIRO_EVAS_GL_MODULE Cairo GL
  39  * @brief  Cairo GL/Evas_GL APIs are offical APIs for Tizen.
  40  * @ingroup OPENSRC_CAIRO_FRAMEWORK
  41  *
  42  * @section CAIRO_EVAS_GL Required Header
  43  *   \#include <cairo-evas-gl.h>
  44  *
  45  * @section CAIRO_EVAS_GL_MODULE_OVERVIEW Overview
  46  * In Tizen, Cairo provides gl backend in order to do hardware-accelerated rendering.
  47  * Since the EGL is not public supported in Tizen, Cairo Evas_GL has been provided to user interfaces instead to allow indirect access to EGL layer.
  48  *
  49  * Features     :\n
  50  *      - Support a new cairo_device structure for interface to the underlying GL or EvasGL.\n
  51  *      - Support a new cairo_surface structure for representing GL or Evas_GL_Surface object that cairo can render to.\n
  52  *      - Get the underlying Evas_GL object used to create cairo device object.\n
  53  *      - Get the underlying Evas_GL_Context object used to create cairo device object.
  54  *
  55  * Remarks      :\n
  56  *      - Cairo GL and Cairo Evas_GL will use an GL/Evas_GL context and API set.\n
  57  *      - Therefore, Evas_GL and OpenGL-ES should be provided for normal operation of Cairo gl backend.\n
  58  */
  59
  60 #endif // __TIZEN_CAIRO_EVAS_GL_DOC_H__