1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/*
* Copyright (c) 2018-2022 Jean-Philippe Bruyère <jp_bruyere@hotmail.com>
*
* 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.
*/
#ifndef VKVG_SVG_H
#define VKVG_SVG_H
#ifdef __cplusplus
extern "C" {
#endif
#ifdef VKVG_SVG
typedef struct _vkvg_svg_t* VkvgSvg;
#else
typedef struct NSVGimage* VkvgSvg;
#endif
/**
* @brief load svg file into @ref surface
*
* Create a new vkvg surface by loading a SVG file.
* @param dev The vkvg @ref device used for creating the surface.
* @param svgFilePath The path of the SVG file to load.
* @param width force the rendering width, if 0 autosize from svg.
* @param height force the rendering height, if 0 autosize from svg.
* @return The new vkvg surface with the loaded SVG drawing as content, or null if an error occured.
*/
vkvg_public VkvgSurface vkvg_surface_create_from_svg(VkvgDevice dev, uint32_t width, uint32_t height,
const char* svgFilePath);
/**
* @brief create surface from svg fragment
*
* Create a new vkvg surface by parsing a string with a valid SVG fragment passed as argument.
* @param dev The vkvg device used for creating the surface.
* @param width force the rendering width, if 0 autosize from svg.
* @param height force the rendering height, if 0 autosize from svg.
* @param svgFragment The SVG fragment to parse.
* @return The new vkvg surface with the parsed SVG fragment as content, or null if an error occured.
*/
vkvg_public VkvgSurface vkvg_surface_create_from_svg_fragment(VkvgDevice dev, uint32_t width, uint32_t height,
char* svgFragment);
/**
* @brief get svg dimensions.
*
* retrieve dimensions from svg parsing.
* @param svg a valid VkvgSvg handle.
* @param width pointer to a valid integer to receive the svg width.
* @param height pointer to a valid integer to receive the svg height.
*/
vkvg_public void vkvg_svg_get_dimensions(VkvgSvg svg, uint32_t* width, uint32_t* height);
/**
* @brief Load svg file in memory.
*
* Open a svg file and store source in memory, head is parsed to query the svg dimensions.
* @param svgFilePath a valid file path to the svg to load.
* @return a VkvgSvg pointer.
*/
vkvg_public VkvgSvg vkvg_svg_load(const char* svgFilePath);
/**
* @brief Load svg from an svg source fragment.
* @param svgFragment A valid svg code fragment.
* @return a VkvgSvg pointer.
*/
vkvg_public VkvgSvg vkvg_svg_load_fragment(char* svgFragment);
/**
* @brief render svg on a context.
* @param svg a valid VkvgSvg handle.
* @param ctx a valid vkvg context.
* @param id an optional id to limit rendering to specific `<g>` elemnt.
*/
vkvg_public void vkvg_svg_render(VkvgSvg svg, VkvgContext ctx, const char* id);
/**
* @brief release VkvgSvg pointer resources.
* @param svg a valid VkvgSvg handle to free.
*/
vkvg_public void vkvg_svg_destroy(VkvgSvg svg);
#ifdef __cplusplus
}
#endif
#endif
|
