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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<!-- HTML header for doxygen 1.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=9" />
<meta name="generator" content="Doxygen 1.9.1" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="vulkan 2d vector drawing library." />
<title>VKVG: Surface</title>
<link href="tabs.css" rel="stylesheet" type="text/css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="custom.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top">
<div id="titlearea">
<table id="titletable" cellspacing="0" cellpadding="0" style="width:100%">
<tr id="titlerow" >
<td id="projectlogo"><img alt="Logo" src="vkvg.svg" /></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">VKVG  </div>
<div id="projectbrief">Vulkan Vector Graphics</div>
</td>
<td align="right"><button style="font-size:16px" onclick="location.href='https://github.com/jpbruyere/vkvg'">View on GitHub <i class="fa fa-github"></i></button></td>
</tr>
</table>
</div>
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Surface</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>This is the reference documentation for creating, using and destroying VKVG Surfaces used as backend for drawing operations. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gaf2e9eb0e48dd4533d4a5622c12e4d0e7"><td class="memItemLeft" align="right" valign="top">typedef struct _vkvg_surface_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a></td></tr>
<tr class="memdesc:gaf2e9eb0e48dd4533d4a5622c12e4d0e7"><td class="mdescLeft"> </td><td class="mdescRight">Opaque pointer on a Vkvg Surface structure. <a href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">More...</a><br /></td></tr>
<tr class="separator:gaf2e9eb0e48dd4533d4a5622c12e4d0e7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac60a50a2726621c5bc3c99b9810ad627"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gac60a50a2726621c5bc3c99b9810ad627.html#gac60a50a2726621c5bc3c99b9810ad627">vkvg_surface_create</a> (<a class="el" href="group__device_ga4410787cc120fdafe8cdc480a2b02e71.html#ga4410787cc120fdafe8cdc480a2b02e71">VkvgDevice</a> dev, uint32_t width, uint32_t height)</td></tr>
<tr class="memdesc:gac60a50a2726621c5bc3c99b9810ad627"><td class="mdescLeft"> </td><td class="mdescRight">Create a new vkvg surface. <a href="group__surface_gac60a50a2726621c5bc3c99b9810ad627.html#gac60a50a2726621c5bc3c99b9810ad627">More...</a><br /></td></tr>
<tr class="separator:gac60a50a2726621c5bc3c99b9810ad627"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab8ea522885d2768088a15f91bfcd3139"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gab8ea522885d2768088a15f91bfcd3139.html#gab8ea522885d2768088a15f91bfcd3139">vkvg_surface_create_from_image</a> (<a class="el" href="group__device_ga4410787cc120fdafe8cdc480a2b02e71.html#ga4410787cc120fdafe8cdc480a2b02e71">VkvgDevice</a> dev, const char *filePath)</td></tr>
<tr class="memdesc:gab8ea522885d2768088a15f91bfcd3139"><td class="mdescLeft"> </td><td class="mdescRight">Create a new vkvg surface by loading an image file. The resulting surface will have the same dimension as the supplied image. <a href="group__surface_gab8ea522885d2768088a15f91bfcd3139.html#gab8ea522885d2768088a15f91bfcd3139">More...</a><br /></td></tr>
<tr class="separator:gab8ea522885d2768088a15f91bfcd3139"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaedc4e2964cf5c9a9c004d2874d73addb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gaedc4e2964cf5c9a9c004d2874d73addb.html#gaedc4e2964cf5c9a9c004d2874d73addb">vkvg_surface_create_for_VkhImage</a> (<a class="el" href="group__device_ga4410787cc120fdafe8cdc480a2b02e71.html#ga4410787cc120fdafe8cdc480a2b02e71">VkvgDevice</a> dev, void *vkhImg)</td></tr>
<tr class="memdesc:gaedc4e2964cf5c9a9c004d2874d73addb"><td class="mdescLeft"> </td><td class="mdescRight">Create a new vkvg surface using an existing vulkan texture as backend. <a href="group__surface_gaedc4e2964cf5c9a9c004d2874d73addb.html#gaedc4e2964cf5c9a9c004d2874d73addb">More...</a><br /></td></tr>
<tr class="separator:gaedc4e2964cf5c9a9c004d2874d73addb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga22a2d413efceb83249e2b4348fe58345"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_ga22a2d413efceb83249e2b4348fe58345.html#ga22a2d413efceb83249e2b4348fe58345">vkvg_surface_reference</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:ga22a2d413efceb83249e2b4348fe58345"><td class="mdescLeft"> </td><td class="mdescRight">Increment reference count on the surface by one. <a href="group__surface_ga22a2d413efceb83249e2b4348fe58345.html#ga22a2d413efceb83249e2b4348fe58345">More...</a><br /></td></tr>
<tr class="separator:ga22a2d413efceb83249e2b4348fe58345"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf4a177cd4af529d4ff1fce0b9e3cba12"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gaf4a177cd4af529d4ff1fce0b9e3cba12.html#gaf4a177cd4af529d4ff1fce0b9e3cba12">vkvg_surface_get_reference_count</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:gaf4a177cd4af529d4ff1fce0b9e3cba12"><td class="mdescLeft"> </td><td class="mdescRight">Get the current reference count on this surface. <a href="group__surface_gaf4a177cd4af529d4ff1fce0b9e3cba12.html#gaf4a177cd4af529d4ff1fce0b9e3cba12">More...</a><br /></td></tr>
<tr class="separator:gaf4a177cd4af529d4ff1fce0b9e3cba12"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4fb66c2cbbebddae0c0b8f69d13325e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_ga4fb66c2cbbebddae0c0b8f69d13325e9.html#ga4fb66c2cbbebddae0c0b8f69d13325e9">vkvg_surface_destroy</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:ga4fb66c2cbbebddae0c0b8f69d13325e9"><td class="mdescLeft"> </td><td class="mdescRight">Decrement the reference count on the surface by one. Destroy it if count reach 0. <a href="group__surface_ga4fb66c2cbbebddae0c0b8f69d13325e9.html#ga4fb66c2cbbebddae0c0b8f69d13325e9">More...</a><br /></td></tr>
<tr class="separator:ga4fb66c2cbbebddae0c0b8f69d13325e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga019fc5428d0ed30a8d764d8bbce3464d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vkvg_8h_a0cf53c292fd50abe53343d71673c9354.html#a0cf53c292fd50abe53343d71673c9354">vkvg_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_ga019fc5428d0ed30a8d764d8bbce3464d.html#ga019fc5428d0ed30a8d764d8bbce3464d">vkvg_surface_status</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:ga019fc5428d0ed30a8d764d8bbce3464d"><td class="mdescLeft"> </td><td class="mdescRight">Query the current status of the surface. <a href="group__surface_ga019fc5428d0ed30a8d764d8bbce3464d.html#ga019fc5428d0ed30a8d764d8bbce3464d">More...</a><br /></td></tr>
<tr class="separator:ga019fc5428d0ed30a8d764d8bbce3464d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad43c411887c5c5bf60daeb62d05af0eb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gad43c411887c5c5bf60daeb62d05af0eb.html#gad43c411887c5c5bf60daeb62d05af0eb">vkvg_surface_clear</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:gad43c411887c5c5bf60daeb62d05af0eb"><td class="mdescLeft"> </td><td class="mdescRight">Clear surface's content. <a href="group__surface_gad43c411887c5c5bf60daeb62d05af0eb.html#gad43c411887c5c5bf60daeb62d05af0eb">More...</a><br /></td></tr>
<tr class="separator:gad43c411887c5c5bf60daeb62d05af0eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga52d86147f436de7d2e138bcb4ee6015c"><td class="memItemLeft" align="right" valign="top">VkImage </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_ga52d86147f436de7d2e138bcb4ee6015c.html#ga52d86147f436de7d2e138bcb4ee6015c">vkvg_surface_get_vk_image</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:ga52d86147f436de7d2e138bcb4ee6015c"><td class="mdescLeft"> </td><td class="mdescRight">Get the final single sampled vulkan image of this surface. <a href="group__surface_ga52d86147f436de7d2e138bcb4ee6015c.html#ga52d86147f436de7d2e138bcb4ee6015c">More...</a><br /></td></tr>
<tr class="separator:ga52d86147f436de7d2e138bcb4ee6015c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga51e2017f312896befb7e3a841d5542c5"><td class="memItemLeft" align="right" valign="top">VkFormat </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_ga51e2017f312896befb7e3a841d5542c5.html#ga51e2017f312896befb7e3a841d5542c5">vkvg_surface_get_vk_format</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:ga51e2017f312896befb7e3a841d5542c5"><td class="mdescLeft"> </td><td class="mdescRight">Get the vulkan format of the vulkan texture used as backend for this surface. <a href="group__surface_ga51e2017f312896befb7e3a841d5542c5.html#ga51e2017f312896befb7e3a841d5542c5">More...</a><br /></td></tr>
<tr class="separator:ga51e2017f312896befb7e3a841d5542c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabbb66e36ee4d187485b0ef4bba8780f3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gabbb66e36ee4d187485b0ef4bba8780f3.html#gabbb66e36ee4d187485b0ef4bba8780f3">vkvg_surface_get_width</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:gabbb66e36ee4d187485b0ef4bba8780f3"><td class="mdescLeft"> </td><td class="mdescRight">Get the actual surface width. <a href="group__surface_gabbb66e36ee4d187485b0ef4bba8780f3.html#gabbb66e36ee4d187485b0ef4bba8780f3">More...</a><br /></td></tr>
<tr class="separator:gabbb66e36ee4d187485b0ef4bba8780f3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga52b10b4864ebba4dd2ce0edc0ed7e9b3"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_ga52b10b4864ebba4dd2ce0edc0ed7e9b3.html#ga52b10b4864ebba4dd2ce0edc0ed7e9b3">vkvg_surface_get_height</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:ga52b10b4864ebba4dd2ce0edc0ed7e9b3"><td class="mdescLeft"> </td><td class="mdescRight">Get the actual surface height. <a href="group__surface_ga52b10b4864ebba4dd2ce0edc0ed7e9b3.html#ga52b10b4864ebba4dd2ce0edc0ed7e9b3">More...</a><br /></td></tr>
<tr class="separator:ga52b10b4864ebba4dd2ce0edc0ed7e9b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac93f58bebe6b797e0e1fcc053ac2e2f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vkvg_8h_a0cf53c292fd50abe53343d71673c9354.html#a0cf53c292fd50abe53343d71673c9354">vkvg_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gaac93f58bebe6b797e0e1fcc053ac2e2f.html#gaac93f58bebe6b797e0e1fcc053ac2e2f">vkvg_surface_write_to_png</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf, const char *path)</td></tr>
<tr class="memdesc:gaac93f58bebe6b797e0e1fcc053ac2e2f"><td class="mdescLeft"> </td><td class="mdescRight">Write surface content to a png file on disk. <a href="group__surface_gaac93f58bebe6b797e0e1fcc053ac2e2f.html#gaac93f58bebe6b797e0e1fcc053ac2e2f">More...</a><br /></td></tr>
<tr class="separator:gaac93f58bebe6b797e0e1fcc053ac2e2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga22e86f6ea6e0095e6d49d80507984768"><td class="memItemLeft" align="right" valign="top"><a class="el" href="vkvg_8h_a0cf53c292fd50abe53343d71673c9354.html#a0cf53c292fd50abe53343d71673c9354">vkvg_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_ga22e86f6ea6e0095e6d49d80507984768.html#ga22e86f6ea6e0095e6d49d80507984768">vkvg_surface_write_to_memory</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf, unsigned char *const bitmap)</td></tr>
<tr class="memdesc:ga22e86f6ea6e0095e6d49d80507984768"><td class="mdescLeft"> </td><td class="mdescRight">Save surface to memory. <a href="group__surface_ga22e86f6ea6e0095e6d49d80507984768.html#ga22e86f6ea6e0095e6d49d80507984768">More...</a><br /></td></tr>
<tr class="separator:ga22e86f6ea6e0095e6d49d80507984768"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac8fc98fe6fbbf93f67a96f1d7e4d5ef9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__surface_gac8fc98fe6fbbf93f67a96f1d7e4d5ef9.html#gac8fc98fe6fbbf93f67a96f1d7e4d5ef9">vkvg_surface_resolve</a> (<a class="el" href="group__surface_gaf2e9eb0e48dd4533d4a5622c12e4d0e7.html#gaf2e9eb0e48dd4533d4a5622c12e4d0e7">VkvgSurface</a> surf)</td></tr>
<tr class="memdesc:gac8fc98fe6fbbf93f67a96f1d7e4d5ef9"><td class="mdescLeft"> </td><td class="mdescRight">Explicitly resolve a multisampled surface. <a href="group__surface_gac8fc98fe6fbbf93f67a96f1d7e4d5ef9.html#gac8fc98fe6fbbf93f67a96f1d7e4d5ef9">More...</a><br /></td></tr>
<tr class="separator:gac8fc98fe6fbbf93f67a96f1d7e4d5ef9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
