inc/thorvg_capi.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *  Licensed under the Apache License, Version 2.0 (the "License");
   5  *  you may not use this file except in compliance with the License.
   6  *  You may obtain a copy of the License at
   7  *
   8  *               http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  */
  17
  18 #ifndef __THORVG_CAPI_H__
  19 #define __THORVG_CAPI_H__
  20
  21 #ifdef TVG_EXPORT
  22     #undef TVG_EXPORT
  23 #endif
  24
  25 #ifdef TVG_BUILD
  26     #define TVG_EXPORT __attribute__ ((visibility ("default")))
  27 #else
  28     #define TVG_EXPORT
  29 #endif
  30
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef struct _Tvg_Canvas Tvg_Canvas;
  37 typedef struct _Tvg_Paint Tvg_Paint;
  38
  39 #define TVG_ENGINE_SW (1 << 1)
  40 #define TVG_ENGINE_GL (1 << 2)
  41
  42
  43 typedef enum {
  44     TVG_RESULT_SUCCESS = 0,
  45     TVG_RESULT_INVALID_ARGUMENT,
  46     TVG_RESULT_INSUFFICIENT_CONDITION,
  47     TVG_RESULT_FAILED_ALLOCATION,
  48     TVG_RESULT_MEMORY_CORRUPTION,
  49     TVG_RESULT_NOT_SUPPORTED,
  50     TVG_RESULT_UNKNOWN
  51 } Tvg_Result;
  52
  53
  54 typedef enum {
  55     TVG_PATH_COMMAND_CLOSE = 0,
  56     TVG_PATH_COMMAND_MOVE_TO,
  57     TVG_PATH_COMMAND_LINE_TO,
  58     TVG_PATH_COMMAND_CUBIC_TO
  59 } Tvg_Path_Command;
  60
  61
  62 typedef enum {
  63     TVG_STROKE_CAP_SQUARE = 0,
  64     TVG_STROKE_CAP_ROUND,
  65     TVG_STROKE_CAP_BUTT
  66 } Tvg_Stroke_Cap;
  67
  68
  69 typedef enum {
  70     TVG_STROKE_JOIN_BEVEL = 0,
  71     TVG_STROKE_JOIN_ROUND,
  72     TVG_STROKE_JOIN_MITER
  73 } Tvg_Stroke_Join;
  74
  75
  76 typedef enum {
  77     TVG_STROKE_FILL_PAD = 0,
  78     TVG_STROKE_FILL_REFLECT,
  79     TVG_STROKE_FILL_REPEAT
  80 } Tvg_Stroke_Fill;
  81
  82
  83 typedef struct
  84 {
  85     float x, y;
  86 } Tvg_Point;
  87
  88
  89 typedef struct
  90 {
  91     float e11, e12, e13;
  92     float e21, e22, e23;
  93     float e31, e32, e33;
  94 } Tvg_Matrix;
  95
  96
  97 /************************************************************************/
  98 /* Engine API                                                           */
  99 /************************************************************************/
 100 TVG_EXPORT Tvg_Result tvg_engine_init(unsigned engine_method);
 101 TVG_EXPORT Tvg_Result tvg_engine_term(unsigned engine_method);
 102
 103
 104 /************************************************************************/
 105 /* SwCanvas API                                                         */
 106 /************************************************************************/
 107 TVG_EXPORT Tvg_Canvas* tvg_swcanvas_create();
 108 TVG_EXPORT Tvg_Result tvg_swcanvas_set_target(Tvg_Canvas* canvas, uint32_t* buffer, uint32_t stride, uint32_t w, uint32_t h);
 109
 110
 111 /************************************************************************/
 112 /* Common Canvas API                                                    */
 113 /************************************************************************/
 114 TVG_EXPORT Tvg_Result tvg_canvas_destroy(Tvg_Canvas* canvas);
 115 TVG_EXPORT Tvg_Result tvg_canvas_push(Tvg_Canvas* canvas, Tvg_Paint* paint);
 116 TVG_EXPORT Tvg_Result tvg_canvas_reserve(Tvg_Canvas* canvas, uint32_t n);
 117 TVG_EXPORT Tvg_Result tvg_canvas_clear(Tvg_Canvas* canvas);
 118 TVG_EXPORT Tvg_Result tvg_canvas_update(Tvg_Canvas* canvas);
 119 TVG_EXPORT Tvg_Result tvg_canvas_update_paint(Tvg_Canvas* canvas, Tvg_Paint* paint);
 120 TVG_EXPORT Tvg_Result tvg_canvas_draw(Tvg_Canvas* canvas, unsigned char async);
 121 TVG_EXPORT Tvg_Result tvg_canvas_sync(Tvg_Canvas* canvas);
 122
 123
 124 /************************************************************************/
 125 /* Shape API                                                            */
 126 /************************************************************************/
 127 TVG_EXPORT Tvg_Paint* tvg_shape_new();
 128 TVG_EXPORT Tvg_Result tvg_shape_del(Tvg_Paint* paint);
 129 TVG_EXPORT Tvg_Result tvg_shape_reset(Tvg_Paint* paint);
 130 TVG_EXPORT Tvg_Result tvg_shape_move_to(Tvg_Paint* paint, float x, float y);
 131 TVG_EXPORT Tvg_Result tvg_shape_line_to(Tvg_Paint* paint, float x, float y);
 132 TVG_EXPORT Tvg_Result tvg_shape_cubic_to(Tvg_Paint* paint, float cx1, float cy1, float cx2, float cy2, float x, float y);
 133 TVG_EXPORT Tvg_Result tvg_shape_close(Tvg_Paint* paint);
 134 TVG_EXPORT Tvg_Result tvg_shape_append_rect(Tvg_Paint* paint, float x, float y, float w, float h, float rx, float ry);
 135 TVG_EXPORT Tvg_Result tvg_shape_append_circle(Tvg_Paint* paint, float cx, float cy, float rx, float ry);
 136 TVG_EXPORT Tvg_Result tvg_shape_append_path(Tvg_Paint* paint, const Tvg_Path_Command* cmds, uint32_t cmdCnt, const Tvg_Point* pts, uint32_t ptsCnt);
 137 TVG_EXPORT Tvg_Result tvg_shape_set_stroke_width(Tvg_Paint* paint, float width);
 138 TVG_EXPORT Tvg_Result tvg_shape_set_stroke_color(Tvg_Paint* paint, uint8_t r, uint8_t g, uint8_t b, uint8_t a);
 139 TVG_EXPORT Tvg_Result tvg_shape_set_stroke_dash(Tvg_Paint* paint, const float* dashPattern, uint32_t cnt);
 140 TVG_EXPORT Tvg_Result tvg_shape_set_stroke_cap(Tvg_Paint* paint, Tvg_Stroke_Cap cap);
 141 TVG_EXPORT Tvg_Result tvg_shape_set_stroke_join(Tvg_Paint* paint, Tvg_Stroke_Join join);
 142 TVG_EXPORT Tvg_Result tvg_shape_fill_color(Tvg_Paint* paint, uint8_t r, uint8_t g, uint8_t b, uint8_t a);
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147
 148 #endif //_THORVG_CAPI_H_