summaryrefslogtreecommitdiffstatsci
path: root/group__device_ga17a593a0a8b3c174b22e7e9a67995257.html
blob: 9ef0d44611ce25d367450540b98a374964e28528 (plain)
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
<!-- 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: vkvg_device_create_from_vk_multisample</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&amp;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 &#160;</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&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="group__device.html">Device</a></li>  </ul>
</div>
</div><!-- top -->
<div class="contents">
<table cellspacing="0" cellpadding="0" border="0">
  <tr>
   <td valign="top">
      <div class="navtab">
        <table>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga78fe5806b41e650f39fdb8b0722efb3c.html#ga78fe5806b41e650f39fdb8b0722efb3c">vkvg_device_create</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga792170a12976eced48e117cc1adf4bcf.html#ga792170a12976eced48e117cc1adf4bcf">vkvg_device_create_from_vk</a></td></tr>
          <tr><td class="navtabHL"><a class="navtab" href="group__device_ga17a593a0a8b3c174b22e7e9a67995257.html#ga17a593a0a8b3c174b22e7e9a67995257">vkvg_device_create_from_vk_multisample</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga2aaf6df4810242a7ba61d1cc22dda83d.html#ga2aaf6df4810242a7ba61d1cc22dda83d">vkvg_device_destroy</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga629ad9c736d5e7936529aadbfc202c53.html#ga629ad9c736d5e7936529aadbfc202c53">vkvg_device_get_dpy</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_gaf8fba0b5d5588ef33326e874bd25a4c1.html#gaf8fba0b5d5588ef33326e874bd25a4c1">vkvg_device_get_reference_count</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga3fbc07e9e6fa4e97dd0857b58e66a916.html#ga3fbc07e9e6fa4e97dd0857b58e66a916">vkvg_device_reference</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga67fe3cfb43415cc557c3c6f2dad1990b.html#ga67fe3cfb43415cc557c3c6f2dad1990b">vkvg_device_set_dpy</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga14c3363f17896c4cbc90b5a742d8cc92.html#ga14c3363f17896c4cbc90b5a742d8cc92">vkvg_device_set_thread_aware</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga7cfe91b5df3581ed1bcdef483d1a2367.html#ga7cfe91b5df3581ed1bcdef483d1a2367">vkvg_device_status</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_gad9676acb47c4f4f8d83ef198280a805e.html#gad9676acb47c4f4f8d83ef198280a805e">vkvg_get_device_requirements</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga87246f77fd32889d9eae62c9444ae456.html#ga87246f77fd32889d9eae62c9444ae456">vkvg_get_required_device_extensions</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga9319a5e85f367098b0e6e3265fb8ea85.html#ga9319a5e85f367098b0e6e3265fb8ea85">vkvg_get_required_instance_extensions</a></td></tr>
          <tr><td class="navtab"><a class="navtab" href="group__device_ga4410787cc120fdafe8cdc480a2b02e71.html#ga4410787cc120fdafe8cdc480a2b02e71">VkvgDevice</a></td></tr>
        </table>
      </div>
   </td>
   <td valign="top" class="mempage">
<a id="ga17a593a0a8b3c174b22e7e9a67995257"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga17a593a0a8b3c174b22e7e9a67995257">&#9670;&nbsp;</a></span>vkvg_device_create_from_vk_multisample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__device_ga4410787cc120fdafe8cdc480a2b02e71.html#ga4410787cc120fdafe8cdc480a2b02e71">VkvgDevice</a> vkvg_device_create_from_vk_multisample </td>
          <td>(</td>
          <td class="paramtype">VkInstance&#160;</td>
          <td class="paramname"><em>inst</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">VkPhysicalDevice&#160;</td>
          <td class="paramname"><em>phy</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">VkDevice&#160;</td>
          <td class="paramname"><em>vkdev</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>qFamIdx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>qIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">VkSampleCountFlags&#160;</td>
          <td class="paramname"><em>samples</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>deferredResolve</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This function allows to create vkvg device for working with multisampled surfaces. Multisampling is used to smooth color transitions in drawings, making lines not pixelised and diagonal edges not stepped. Multisampling has a performance cost. The final image of the surface, accessible by the user will be a resolved single sampled image.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inst</td><td>Vulkan instance to create the device from. </td></tr>
    <tr><td class="paramname">phy</td><td>Vulkan physical device used to create the vkvg device. </td></tr>
    <tr><td class="paramname">vkdev</td><td>Vulkan logical device to create the vkvg device for. </td></tr>
    <tr><td class="paramname">qFamIdx</td><td>Queue family Index of the graphic queue used for drawing operations. </td></tr>
    <tr><td class="paramname">qIndex</td><td>Index of the queue into the choosen familly, 0 in general. </td></tr>
    <tr><td class="paramname">samples</td><td>The sample count that will be setup for the surfaces created by this device. </td></tr>
    <tr><td class="paramname">deferredResolve</td><td>If true, the final simple sampled image of the surface will only be resolved on demand when calling <a class="el" href="group__surface_ga52d86147f436de7d2e138bcb4ee6015c.html#ga52d86147f436de7d2e138bcb4ee6015c">vkvg_surface_get_vk_image</a> or by explicitly calling vkvg_multisample_surface_resolve. If false, multisampled image is resolved on each draw operation. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The handle of the created vkvg device, or null if an error occured. </dd></dl>

</div>
</div>
    </td>
  </tr>
</table>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>