/usr/share/doc/libjuce/apiref/structOpenGLGraphicsContextCustomShader.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | <!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>
<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.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: OpenGLGraphicsContextCustomShader Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="structOpenGLGraphicsContextCustomShader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OpenGLGraphicsContextCustomShader Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used to create custom shaders for use with an openGL 2D rendering context.
<a href="structOpenGLGraphicsContextCustomShader.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:abe63206a00775b46b300d1583510f7d4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenGLGraphicsContextCustomShader.html#abe63206a00775b46b300d1583510f7d4">OpenGLGraphicsContextCustomShader</a> (const <a class="el" href="classString.html">String</a> &fragmentShaderCode)</td></tr>
<tr class="memdesc:abe63206a00775b46b300d1583510f7d4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a custom shader. <a href="#abe63206a00775b46b300d1583510f7d4">More...</a><br /></td></tr>
<tr class="separator:abe63206a00775b46b300d1583510f7d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a847370481b14927f5571dbb24bf4110b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenGLGraphicsContextCustomShader.html#a847370481b14927f5571dbb24bf4110b">~OpenGLGraphicsContextCustomShader</a> ()</td></tr>
<tr class="memdesc:a847370481b14927f5571dbb24bf4110b"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a847370481b14927f5571dbb24bf4110b">More...</a><br /></td></tr>
<tr class="separator:a847370481b14927f5571dbb24bf4110b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a2b0c6aecfc643056042ba28a8e736c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenGLShaderProgram.html">OpenGLShaderProgram</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenGLGraphicsContextCustomShader.html#a4a2b0c6aecfc643056042ba28a8e736c">getProgram</a> (<a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a> &) const</td></tr>
<tr class="memdesc:a4a2b0c6aecfc643056042ba28a8e736c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the program, if it has been linked and is active. <a href="#a4a2b0c6aecfc643056042ba28a8e736c">More...</a><br /></td></tr>
<tr class="separator:a4a2b0c6aecfc643056042ba28a8e736c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7dae710e291ffb9c72328ac2a66586f1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenGLGraphicsContextCustomShader.html#a7dae710e291ffb9c72328ac2a66586f1">fillRect</a> (<a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a> &, const <a class="el" href="classRectangle.html">Rectangle</a>< int > &area) const</td></tr>
<tr class="memdesc:a7dae710e291ffb9c72328ac2a66586f1"><td class="mdescLeft"> </td><td class="mdescRight">Applies the shader to a rectangle within the graphics context. <a href="#a7dae710e291ffb9c72328ac2a66586f1">More...</a><br /></td></tr>
<tr class="separator:a7dae710e291ffb9c72328ac2a66586f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5de4f059f36513f3c737f61788eb4429"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classResult.html">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenGLGraphicsContextCustomShader.html#a5de4f059f36513f3c737f61788eb4429">checkCompilation</a> (<a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a> &)</td></tr>
<tr class="memdesc:a5de4f059f36513f3c737f61788eb4429"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to compile the program if necessary, and returns an error message if it fails. <a href="#a5de4f059f36513f3c737f61788eb4429">More...</a><br /></td></tr>
<tr class="separator:a5de4f059f36513f3c737f61788eb4429"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a804fed2adafca351b7d0a23c5aaf73f0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenGLGraphicsContextCustomShader.html#a804fed2adafca351b7d0a23c5aaf73f0">getFragmentShaderCode</a> () const noexcept</td></tr>
<tr class="memdesc:a804fed2adafca351b7d0a23c5aaf73f0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the code that was used to create this object. <a href="#a804fed2adafca351b7d0a23c5aaf73f0">More...</a><br /></td></tr>
<tr class="separator:a804fed2adafca351b7d0a23c5aaf73f0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used to create custom shaders for use with an openGL 2D rendering context. </p>
<p>Given a GL-based rendering context, you can write a fragment shader that applies some kind of per-pixel effect. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="abe63206a00775b46b300d1583510f7d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe63206a00775b46b300d1583510f7d4">§ </a></span>OpenGLGraphicsContextCustomShader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenGLGraphicsContextCustomShader::OpenGLGraphicsContextCustomShader </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>fragmentShaderCode</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a custom shader. </p>
<p>The shader code will not be compiled until actually needed, so it's OK to call this constructor when no GL context is active.</p>
<p>The code should be a normal fragment shader. As well as the usual GLSL variables, there is also an automatically declared varying vec2 called "pixelPos", which indicates the pixel position within the graphics context of the pixel being drawn. There is also a varying value "pixelAlpha", which indicates the alpha by which the pixel should be multiplied, so that the edges of any clip-region masks are anti-aliased correctly. </p>
</div>
</div>
<a id="a847370481b14927f5571dbb24bf4110b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a847370481b14927f5571dbb24bf4110b">§ </a></span>~OpenGLGraphicsContextCustomShader()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OpenGLGraphicsContextCustomShader::~OpenGLGraphicsContextCustomShader </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a4a2b0c6aecfc643056042ba28a8e736c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a2b0c6aecfc643056042ba28a8e736c">§ </a></span>getProgram()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenGLShaderProgram.html">OpenGLShaderProgram</a>* OpenGLGraphicsContextCustomShader::getProgram </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the program, if it has been linked and is active. </p>
<p>This can be called when you're about to use fillRect, to set up any uniforms/textures that the program may require. </p>
</div>
</div>
<a id="a7dae710e291ffb9c72328ac2a66586f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7dae710e291ffb9c72328ac2a66586f1">§ </a></span>fillRect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenGLGraphicsContextCustomShader::fillRect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a> & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classRectangle.html">Rectangle</a>< int > & </td>
<td class="paramname"><em>area</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Applies the shader to a rectangle within the graphics context. </p>
</div>
</div>
<a id="a5de4f059f36513f3c737f61788eb4429"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5de4f059f36513f3c737f61788eb4429">§ </a></span>checkCompilation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classResult.html">Result</a> OpenGLGraphicsContextCustomShader::checkCompilation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classLowLevelGraphicsContext.html">LowLevelGraphicsContext</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to compile the program if necessary, and returns an error message if it fails. </p>
</div>
</div>
<a id="a804fed2adafca351b7d0a23c5aaf73f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a804fed2adafca351b7d0a23c5aaf73f0">§ </a></span>getFragmentShaderCode()</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="classString.html">String</a>& OpenGLGraphicsContextCustomShader::getFragmentShaderCode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the code that was used to create this object. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a851b02724a8158a7f746c66b5758b3dd">JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="juce__OpenGLGraphicsContext_8h.html">juce_OpenGLGraphicsContext.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|