diff options
Diffstat (limited to 'docs/Classes/SDLRGBColor.html')
| -rw-r--r-- | docs/Classes/SDLRGBColor.html | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/docs/Classes/SDLRGBColor.html b/docs/Classes/SDLRGBColor.html new file mode 100644 index 000000000..a5469ba26 --- /dev/null +++ b/docs/Classes/SDLRGBColor.html @@ -0,0 +1,141 @@ +<h1>SDLRGBColor Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithRed:green:blue:">-initWithRed:green:blue:</a></li> + <li><a href="#section--initWithColor:">-initWithColor:</a></li> + <li><a href="#section-red">red</a></li> + <li><a href="#section-green">green</a></li> + <li><a href="#section-blue">blue</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithRed:green:blue:"> + -initWithRed:green:blue: + </h3> + + <p>Create an SDL color object with red / green / blue values between 0-255</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithRed</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">red</span> + <span class="nf">green</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">green</span> + <span class="nf">blue</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">blue</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">red</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">green</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="nv">blue</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>red</dt> + <dd><p>The red value of the color</p></dd> + <dt>green</dt> + <dd><p>The green value of the color</p></dd> + <dt>blue</dt> + <dd><p>The blue value of the color</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The color</p> + </div> + + <h3 id="section--initWithColor:"> + -initWithColor: + </h3> + + <p>Create an SDL color object with a UIColor object.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>The alpha color of the UIColor object will be ignored</p> + +</div> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithColor</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">color</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">color</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>color</dt> + <dd><p>The UIColor object to base this color on</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The color</p> + </div> + + <h3 id="section-red"> + red + </h3> + + <p>The red value of the RGB color +Required, Integer, 0-255</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">red</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">red</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-green"> + green + </h3> + + <p>The green value of the RGB color +Required, Integer, 0-255</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">green</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">green</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-blue"> + blue + </h3> + + <p>The blue value of the RGB color +Required, Integer, 0-255</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">blue</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">blue</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> |