UnrealXR/raylib-python-cffi
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs update

Browse source
This commit is contained in:
Richard Smith 2024-07-02 09:58:07 +01:00
parent 812f0f7527
commit 43630d8b5a
17 changed files with 242 additions and 163 deletions
Download patch file Download diff file Expand all files Collapse all files

56
docs/pyray.html
View file

@ -7,7 +7,7 @@
<title>Python API &mdash; Raylib Python documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=fd3f3429" />
<!--[if lt IE 9]>
@ -17,7 +17,7 @@
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
@ -2001,27 +2001,27 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.BEIGE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BEIGE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(211,</span> <span class="pre">176,</span> <span class="pre">131,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.BEIGE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BEIGE</span></span><a class="headerlink" href="#pyray.BEIGE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.BLACK">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BLACK</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.BLACK" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BLACK</span></span><a class="headerlink" href="#pyray.BLACK" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.BLANK">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BLANK</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(0,</span> <span class="pre">0,</span> <span class="pre">0,</span> <span class="pre">0)</span></em><a class="headerlink" href="#pyray.BLANK" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BLANK</span></span><a class="headerlink" href="#pyray.BLANK" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.BLUE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BLUE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(0,</span> <span class="pre">121,</span> <span class="pre">241,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.BLUE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BLUE</span></span><a class="headerlink" href="#pyray.BLUE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.BROWN">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BROWN</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(127,</span> <span class="pre">106,</span> <span class="pre">79,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.BROWN" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">BROWN</span></span><a class="headerlink" href="#pyray.BROWN" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -2271,27 +2271,27 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.DARKBLUE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKBLUE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(0,</span> <span class="pre">82,</span> <span class="pre">172,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.DARKBLUE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKBLUE</span></span><a class="headerlink" href="#pyray.DARKBLUE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.DARKBROWN">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKBROWN</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(76,</span> <span class="pre">63,</span> <span class="pre">47,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.DARKBROWN" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKBROWN</span></span><a class="headerlink" href="#pyray.DARKBROWN" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.DARKGRAY">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKGRAY</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(80,</span> <span class="pre">80,</span> <span class="pre">80,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.DARKGRAY" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKGRAY</span></span><a class="headerlink" href="#pyray.DARKGRAY" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.DARKGREEN">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKGREEN</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(0,</span> <span class="pre">117,</span> <span class="pre">44,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.DARKGREEN" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKGREEN</span></span><a class="headerlink" href="#pyray.DARKGREEN" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.DARKPURPLE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKPURPLE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(112,</span> <span class="pre">31,</span> <span class="pre">126,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.DARKPURPLE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">DARKPURPLE</span></span><a class="headerlink" href="#pyray.DARKPURPLE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -2329,17 +2329,17 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.GOLD">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">GOLD</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(255,</span> <span class="pre">203,</span> <span class="pre">0,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.GOLD" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">GOLD</span></span><a class="headerlink" href="#pyray.GOLD" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.GRAY">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">GRAY</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(130,</span> <span class="pre">130,</span> <span class="pre">130,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.GRAY" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">GRAY</span></span><a class="headerlink" href="#pyray.GRAY" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.GREEN">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">GREEN</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(0,</span> <span class="pre">228,</span> <span class="pre">48,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.GREEN" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">GREEN</span></span><a class="headerlink" href="#pyray.GREEN" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -4895,22 +4895,22 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.LIGHTGRAY">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">LIGHTGRAY</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(200,</span> <span class="pre">200,</span> <span class="pre">200,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.LIGHTGRAY" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">LIGHTGRAY</span></span><a class="headerlink" href="#pyray.LIGHTGRAY" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.LIME">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">LIME</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(0,</span> <span class="pre">158,</span> <span class="pre">47,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.LIME" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">LIME</span></span><a class="headerlink" href="#pyray.LIME" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.MAGENTA">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">MAGENTA</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(255,</span> <span class="pre">0,</span> <span class="pre">255,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.MAGENTA" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">MAGENTA</span></span><a class="headerlink" href="#pyray.MAGENTA" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.MAROON">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">MAROON</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(190,</span> <span class="pre">33,</span> <span class="pre">55,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.MAROON" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">MAROON</span></span><a class="headerlink" href="#pyray.MAROON" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -5153,17 +5153,17 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.ORANGE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">ORANGE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(255,</span> <span class="pre">161,</span> <span class="pre">0,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.ORANGE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">ORANGE</span></span><a class="headerlink" href="#pyray.ORANGE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.PINK">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">PINK</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(255,</span> <span class="pre">109,</span> <span class="pre">194,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.PINK" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">PINK</span></span><a class="headerlink" href="#pyray.PINK" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.PURPLE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">PURPLE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(200,</span> <span class="pre">122,</span> <span class="pre">255,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.PURPLE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">PURPLE</span></span><a class="headerlink" href="#pyray.PURPLE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -5318,12 +5318,12 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.RAYWHITE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">RAYWHITE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(245,</span> <span class="pre">245,</span> <span class="pre">245,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.RAYWHITE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">RAYWHITE</span></span><a class="headerlink" href="#pyray.RAYWHITE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py data">
<dt class="sig sig-object py" id="pyray.RED">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">RED</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(230,</span> <span class="pre">41,</span> <span class="pre">55,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.RED" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">RED</span></span><a class="headerlink" href="#pyray.RED" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -5352,7 +5352,7 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.SKYBLUE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">SKYBLUE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(102,</span> <span class="pre">191,</span> <span class="pre">255,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.SKYBLUE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">SKYBLUE</span></span><a class="headerlink" href="#pyray.SKYBLUE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -5708,7 +5708,7 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.VIOLET">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">VIOLET</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(135,</span> <span class="pre">60,</span> <span class="pre">190,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.VIOLET" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">VIOLET</span></span><a class="headerlink" href="#pyray.VIOLET" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -5743,7 +5743,7 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.WHITE">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">WHITE</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(255,</span> <span class="pre">255,</span> <span class="pre">255,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.WHITE" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">WHITE</span></span><a class="headerlink" href="#pyray.WHITE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py class">
@ -5754,7 +5754,7 @@
<dl class="py data">
<dt class="sig sig-object py" id="pyray.YELLOW">
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">YELLOW</span></span><em class="property"><span class="w"> </span><span class="pre">=</span> <span class="pre">(253,</span> <span class="pre">249,</span> <span class="pre">0,</span> <span class="pre">255)</span></em><a class="headerlink" href="#pyray.YELLOW" title="Link to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">pyray.</span></span><span class="sig-name descname"><span class="pre">YELLOW</span></span><a class="headerlink" href="#pyray.YELLOW" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">