summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLImageType.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLImageType.html')
-rw-r--r--docs/Classes/SDLImageType.html124
1 files changed, 124 insertions, 0 deletions
diff --git a/docs/Classes/SDLImageType.html b/docs/Classes/SDLImageType.html
new file mode 100644
index 000000000..2f97e7bab
--- /dev/null
+++ b/docs/Classes/SDLImageType.html
@@ -0,0 +1,124 @@
+<h1>SDLImageType Class Reference</h1>
+
+<h3>Section Contents</h3>
+
+<ul>
+ <li><a href="#section-+valueOf:">+valueOf:</a></li>
+ <li><a href="#section-+values">+values</a></li>
+ <li><a href="#section-+STATIC">+STATIC</a></li>
+ <li><a href="#section-+DYNAMIC">+DYNAMIC</a></li>
+</ul>
+
+<h3>Overview</h3>
+
+<p>Contains information about the type of image.</p>
+
+<p>@since SDL 2.0</p>
+
+
+<section class="section task-group-section">
+ <h3>
+ +valueOf:
+ </h3>
+
+ <p>@abstract return SDLImageType (STATIC / DYNAMIC)</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageType</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">valueOf</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">SDLImageType</span><span class="o">!</span></code></pre>
+
+
+
+ <h4>Parameters</h4>
+ <dl>
+ <dt>value</dt>
+ <dd><p>The value of the string to get an object for</p>
+</dd>
+ </dl>
+ <div>
+ <h4>Return Value</h4>
+ <p>An SDLImageType</p>
+
+ </div>
+
+ <h3>
+ +values
+ </h3>
+
+ <p>@abstract store all possible SDLImageType values</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="p">[</span><span class="kt">AnyObject</span><span class="p">]</span><span class="o">!</span></code></pre>
+
+
+
+ <div>
+ <h4>Return Value</h4>
+ <p>An array with all possible SDLImageType values inside</p>
+
+ </div>
+
+ <h3>
+ +STATIC
+ </h3>
+
+ <p>@abstract Just the static hex icon value to be used</p>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageType</span> <span class="o">*</span><span class="p">)</span><span class="n">STATIC</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">STATIC</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLImageType</span><span class="o">!</span></code></pre>
+
+
+
+ <div>
+ <h4>Return Value</h4>
+ <p>The Image Type with value <em>STATIC</em></p>
+
+ </div>
+
+ <h3>
+ +DYNAMIC
+ </h3>
+
+ <p>@abstract Binary image file to be used (identifier to be sent by SDLPutFile)</p>
+
+<div class="aside aside-see">
+ <p class="aside-title">See</p>
+ <p>SDLPutFile</p>
+
+</div>
+
+
+
+ <h4>Objective-C</h4>
+ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageType</span> <span class="o">*</span><span class="p">)</span><span class="n">DYNAMIC</span><span class="p">;</span></code></pre>
+
+
+ <h4>Swift</h4>
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">DYNAMIC</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">SDLImageType</span><span class="o">!</span></code></pre>
+
+
+
+ <div>
+ <h4>Return Value</h4>
+ <p>The Image Type with value <em>DYNAMIC</em></p>
+
+ </div>
+
+</section>