joseph-aquino
/
2d-platformer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2d-platformer/vendor/SFML-3.0.0/doc/html/classsf_1_1VertexArray.html

517 lines
29 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>SFML - Simple and Fast Multimedia Library</title>
<meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link rel="stylesheet" type="text/css" href="search/search.css" />
<link rel="stylesheet" type="text/css" href="searchOverrides.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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
</head>
<body>
<div id="banner-container">
<div id="banner">
<span id="sfml">SFML 3.0.0</span>
</div>
</div>
<div id="content">
<div>
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="topics.html"><span>Topics</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1VertexArray.html">VertexArray</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classsf_1_1VertexArray-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">sf::VertexArray Class Reference<div class="ingroups"><a class="el" href="group__graphics.html">Graphics module</a></div></div></div>
</div><!--header-->
<div class="contents">
<p>Set of one or more 2D primitives.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="VertexArray_8hpp_source.html">SFML/Graphics/VertexArray.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for sf::VertexArray:</div>
<div class="dyncontent">
<div class="center">
<img src="classsf_1_1VertexArray.png" usemap="#sf::VertexArray_map" alt=""/>
<map id="sf::VertexArray_map" name="sf::VertexArray_map">
<area href="classsf_1_1Drawable.html" title="Abstract base class for objects that can be drawn to a render target." alt="sf::Drawable" shape="rect" coords="0,0,98,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae08fac1f6274698f55c752bd3ef11ba3" id="r_ae08fac1f6274698f55c752bd3ef11ba3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae08fac1f6274698f55c752bd3ef11ba3">VertexArray</a> ()=default</td></tr>
<tr class="memdesc:ae08fac1f6274698f55c752bd3ef11ba3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:ae08fac1f6274698f55c752bd3ef11ba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bb1c29a0e3354a035075899d84f02f9" id="r_a4bb1c29a0e3354a035075899d84f02f9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4bb1c29a0e3354a035075899d84f02f9">VertexArray</a> (<a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a> type, std::size_t vertexCount=0)</td></tr>
<tr class="memdesc:a4bb1c29a0e3354a035075899d84f02f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the vertex array with a type and an initial number of vertices. <br /></td></tr>
<tr class="separator:a4bb1c29a0e3354a035075899d84f02f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abda90e8d841a273d93164f0c0032bd8d" id="r_abda90e8d841a273d93164f0c0032bd8d"><td class="memItemLeft" align="right" valign="top">std::size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abda90e8d841a273d93164f0c0032bd8d">getVertexCount</a> () const</td></tr>
<tr class="memdesc:abda90e8d841a273d93164f0c0032bd8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the vertex count. <br /></td></tr>
<tr class="separator:abda90e8d841a273d93164f0c0032bd8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a913953848726c1c65f8617497e8fccd6" id="r_a913953848726c1c65f8617497e8fccd6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structsf_1_1Vertex.html">Vertex</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a913953848726c1c65f8617497e8fccd6">operator[]</a> (std::size_t index)</td></tr>
<tr class="memdesc:a913953848726c1c65f8617497e8fccd6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a read-write access to a vertex by its index. <br /></td></tr>
<tr class="separator:a913953848726c1c65f8617497e8fccd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8336081e73a14a5e4ad0aa9f926d82be" id="r_a8336081e73a14a5e4ad0aa9f926d82be"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structsf_1_1Vertex.html">Vertex</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8336081e73a14a5e4ad0aa9f926d82be">operator[]</a> (std::size_t index) const</td></tr>
<tr class="memdesc:a8336081e73a14a5e4ad0aa9f926d82be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a read-only access to a vertex by its index. <br /></td></tr>
<tr class="separator:a8336081e73a14a5e4ad0aa9f926d82be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3654c424aca1f9e468f369bc777c839c" id="r_a3654c424aca1f9e468f369bc777c839c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3654c424aca1f9e468f369bc777c839c">clear</a> ()</td></tr>
<tr class="memdesc:a3654c424aca1f9e468f369bc777c839c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the vertex array. <br /></td></tr>
<tr class="separator:a3654c424aca1f9e468f369bc777c839c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c0fe239e8f9a54e64d3bbc96bf548c0" id="r_a0c0fe239e8f9a54e64d3bbc96bf548c0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c0fe239e8f9a54e64d3bbc96bf548c0">resize</a> (std::size_t vertexCount)</td></tr>
<tr class="memdesc:a0c0fe239e8f9a54e64d3bbc96bf548c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resize the vertex array. <br /></td></tr>
<tr class="separator:a0c0fe239e8f9a54e64d3bbc96bf548c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80c8f6865e53bd21fc6cb10fffa10035" id="r_a80c8f6865e53bd21fc6cb10fffa10035"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a80c8f6865e53bd21fc6cb10fffa10035">append</a> (const <a class="el" href="structsf_1_1Vertex.html">Vertex</a> &amp;vertex)</td></tr>
<tr class="memdesc:a80c8f6865e53bd21fc6cb10fffa10035"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a vertex to the array. <br /></td></tr>
<tr class="separator:a80c8f6865e53bd21fc6cb10fffa10035"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa38c10707c28a97f4627ae8b2f3ad969" id="r_aa38c10707c28a97f4627ae8b2f3ad969"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa38c10707c28a97f4627ae8b2f3ad969">setPrimitiveType</a> (<a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a> type)</td></tr>
<tr class="memdesc:aa38c10707c28a97f4627ae8b2f3ad969"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the type of primitives to draw. <br /></td></tr>
<tr class="separator:aa38c10707c28a97f4627ae8b2f3ad969"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1a60d84543aa6e220683349b645f130" id="r_aa1a60d84543aa6e220683349b645f130"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa1a60d84543aa6e220683349b645f130">getPrimitiveType</a> () const</td></tr>
<tr class="memdesc:aa1a60d84543aa6e220683349b645f130"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the type of primitives drawn by the vertex array. <br /></td></tr>
<tr class="separator:aa1a60d84543aa6e220683349b645f130"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd57744c732abfc7d4c98d8e1d4ccca1" id="r_abd57744c732abfc7d4c98d8e1d4ccca1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#a701020eb396e62ba560619e68c689a38">FloatRect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abd57744c732abfc7d4c98d8e1d4ccca1">getBounds</a> () const</td></tr>
<tr class="memdesc:abd57744c732abfc7d4c98d8e1d4ccca1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the bounding rectangle of the vertex array. <br /></td></tr>
<tr class="separator:abd57744c732abfc7d4c98d8e1d4ccca1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Set of one or more 2D primitives. </p>
<p><code><a class="el" href="classsf_1_1VertexArray.html" title="Set of one or more 2D primitives.">sf::VertexArray</a></code> is a very simple wrapper around a dynamic array of vertices and a primitives type.</p>
<p>It inherits <code><a class="el" href="classsf_1_1Drawable.html" title="Abstract base class for objects that can be drawn to a render target.">sf::Drawable</a></code>, but unlike other drawables it is not transformable.</p>
<p>Example: </p><div class="fragment"><div class="line"><a class="code hl_class" href="classsf_1_1VertexArray.html">sf::VertexArray</a> lines(<a class="code hl_enumvalue" href="group__graphics.html#gga5ee56ac1339984909610713096283b1bae7f9e73b8edd21f420a63b3ace5768a2">sf::PrimitiveType::LineStrip</a>, 4);</div>
<div class="line">lines[0].position = <a class="code hl_typedef" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">sf::Vector2f</a>(10, 0);</div>
<div class="line">lines[1].position = <a class="code hl_typedef" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">sf::Vector2f</a>(20, 0);</div>
<div class="line">lines[2].position = <a class="code hl_typedef" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">sf::Vector2f</a>(30, 5);</div>
<div class="line">lines[3].position = <a class="code hl_typedef" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">sf::Vector2f</a>(40, 2);</div>
<div class="line"> </div>
<div class="line">window.draw(lines);</div>
<div class="ttc" id="aclasssf_1_1VertexArray_html"><div class="ttname"><a href="classsf_1_1VertexArray.html">sf::VertexArray</a></div><div class="ttdoc">Set of one or more 2D primitives.</div><div class="ttdef"><b>Definition</b> <a href="VertexArray_8hpp_source.html#l00051">VertexArray.hpp:52</a></div></div>
<div class="ttc" id="agroup__graphics_html_gga5ee56ac1339984909610713096283b1bae7f9e73b8edd21f420a63b3ace5768a2"><div class="ttname"><a href="group__graphics.html#gga5ee56ac1339984909610713096283b1bae7f9e73b8edd21f420a63b3ace5768a2">sf::PrimitiveType::LineStrip</a></div><div class="ttdeci">@ LineStrip</div><div class="ttdoc">List of connected lines, a point uses the previous point to form a line.</div></div>
<div class="ttc" id="anamespacesf_html_af14b40e82368dd601a7ef8037214804d"><div class="ttname"><a href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">sf::Vector2f</a></div><div class="ttdeci">Vector2&lt; float &gt; Vector2f</div><div class="ttdef"><b>Definition</b> <a href="Vector2_8hpp_source.html#l00210">Vector2.hpp:210</a></div></div>
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="structsf_1_1Vertex.html" title="Point with color and texture coordinates.">sf::Vertex</a></code> </dd></dl>
<p class="definition">Definition at line <a class="el" href="VertexArray_8hpp_source.html#l00051">51</a> of file <a class="el" href="VertexArray_8hpp_source.html">VertexArray.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ae08fac1f6274698f55c752bd3ef11ba3" name="ae08fac1f6274698f55c752bd3ef11ba3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae08fac1f6274698f55c752bd3ef11ba3">&#9670;&#160;</a></span>VertexArray() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::VertexArray::VertexArray </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor. </p>
<p>Creates an empty vertex array. </p>
</div>
</div>
<a id="a4bb1c29a0e3354a035075899d84f02f9" name="a4bb1c29a0e3354a035075899d84f02f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bb1c29a0e3354a035075899d84f02f9">&#9670;&#160;</a></span>VertexArray() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sf::VertexArray::VertexArray </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>vertexCount</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0</span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct the vertex array with a type and an initial number of vertices. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Type of primitives </td></tr>
<tr><td class="paramname">vertexCount</td><td>Initial number of vertices in the array </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a80c8f6865e53bd21fc6cb10fffa10035" name="a80c8f6865e53bd21fc6cb10fffa10035"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80c8f6865e53bd21fc6cb10fffa10035">&#9670;&#160;</a></span>append()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::VertexArray::append </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structsf_1_1Vertex.html">Vertex</a> &amp;</td> <td class="paramname"><span class="paramname"><em>vertex</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a vertex to the array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vertex</td><td><a class="el" href="structsf_1_1Vertex.html" title="Point with color and texture coordinates.">Vertex</a> to add </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a3654c424aca1f9e468f369bc777c839c" name="a3654c424aca1f9e468f369bc777c839c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3654c424aca1f9e468f369bc777c839c">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::VertexArray::clear </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Clear the vertex array. </p>
<p>This function removes all the vertices from the array. It doesn't deallocate the corresponding memory, so that adding new vertices after clearing doesn't involve reallocating all the memory. </p>
</div>
</div>
<a id="abd57744c732abfc7d4c98d8e1d4ccca1" name="abd57744c732abfc7d4c98d8e1d4ccca1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd57744c732abfc7d4c98d8e1d4ccca1">&#9670;&#160;</a></span>getBounds()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacesf.html#a701020eb396e62ba560619e68c689a38">FloatRect</a> sf::VertexArray::getBounds </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the bounding rectangle of the vertex array. </p>
<p>This function returns the minimal axis-aligned rectangle that contains all the vertices of the array.</p>
<dl class="section return"><dt>Returns</dt><dd>Bounding rectangle of the vertex array </dd></dl>
</div>
</div>
<a id="aa1a60d84543aa6e220683349b645f130" name="aa1a60d84543aa6e220683349b645f130"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa1a60d84543aa6e220683349b645f130">&#9670;&#160;</a></span>getPrimitiveType()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a> sf::VertexArray::getPrimitiveType </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the type of primitives drawn by the vertex array. </p>
<dl class="section return"><dt>Returns</dt><dd>Primitive type </dd></dl>
</div>
</div>
<a id="abda90e8d841a273d93164f0c0032bd8d" name="abda90e8d841a273d93164f0c0032bd8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abda90e8d841a273d93164f0c0032bd8d">&#9670;&#160;</a></span>getVertexCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::size_t sf::VertexArray::getVertexCount </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the vertex count. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of vertices in the array </dd></dl>
</div>
</div>
<a id="a913953848726c1c65f8617497e8fccd6" name="a913953848726c1c65f8617497e8fccd6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a913953848726c1c65f8617497e8fccd6">&#9670;&#160;</a></span>operator[]() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsf_1_1Vertex.html">Vertex</a> &amp; sf::VertexArray::operator[] </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a read-write access to a vertex by its index. </p>
<p>This function doesn't check <code>index</code>, it must be in range [0, <code><a class="el" href="#abda90e8d841a273d93164f0c0032bd8d" title="Return the vertex count.">getVertexCount()</a></code> - 1]. The behavior is undefined otherwise.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Index of the vertex to get</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Reference to the <code>index</code>-th vertex</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#abda90e8d841a273d93164f0c0032bd8d" title="Return the vertex count.">getVertexCount</a></code> </dd></dl>
</div>
</div>
<a id="a8336081e73a14a5e4ad0aa9f926d82be" name="a8336081e73a14a5e4ad0aa9f926d82be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8336081e73a14a5e4ad0aa9f926d82be">&#9670;&#160;</a></span>operator[]() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structsf_1_1Vertex.html">Vertex</a> &amp; sf::VertexArray::operator[] </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>index</em></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a read-only access to a vertex by its index. </p>
<p>This function doesn't check <code>index</code>, it must be in range [0, <code><a class="el" href="#abda90e8d841a273d93164f0c0032bd8d" title="Return the vertex count.">getVertexCount()</a></code> - 1]. The behavior is undefined otherwise.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>Index of the vertex to get</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Const reference to the <code>index</code>-th vertex</dd></dl>
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#abda90e8d841a273d93164f0c0032bd8d" title="Return the vertex count.">getVertexCount</a></code> </dd></dl>
</div>
</div>
<a id="a0c0fe239e8f9a54e64d3bbc96bf548c0" name="a0c0fe239e8f9a54e64d3bbc96bf548c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c0fe239e8f9a54e64d3bbc96bf548c0">&#9670;&#160;</a></span>resize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::VertexArray::resize </td>
<td>(</td>
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>vertexCount</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resize the vertex array. </p>
<p>If <code>vertexCount</code> is greater than the current size, the previous vertices are kept and new (default-constructed) vertices are added. If <code>vertexCount</code> is less than the current size, existing vertices are removed from the array.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">vertexCount</td><td>New size of the array (number of vertices) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa38c10707c28a97f4627ae8b2f3ad969" name="aa38c10707c28a97f4627ae8b2f3ad969"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa38c10707c28a97f4627ae8b2f3ad969">&#9670;&#160;</a></span>setPrimitiveType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sf::VertexArray::setPrimitiveType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a></td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the type of primitives to draw. </p>
<p>This function defines how the vertices must be interpreted when it's time to draw them: </p><ul>
<li>As points </li>
<li>As lines </li>
<li>As triangles The default primitive type is <code><a class="el" href="group__graphics.html#gga5ee56ac1339984909610713096283b1ba75dd5f1160a3f02b6fae89c54361a1b3" title="List of individual points.">sf::PrimitiveType::Points</a></code>.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Type of primitive </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="VertexArray_8hpp_source.html">VertexArray.hpp</a></li>
</ul>
</div><!-- contents -->
</div>
<div id="footer-container">
<div id="footer">
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br />
Copyright &copy; Laurent Gomila &nbsp;::&nbsp;
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> &nbsp;::&nbsp;
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink