diff options
Diffstat (limited to 'docs/Classes/SDLImage.html')
-rw-r--r-- | docs/Classes/SDLImage.html | 155 |
1 files changed, 149 insertions, 6 deletions
diff --git a/docs/Classes/SDLImage.html b/docs/Classes/SDLImage.html index d792b4521..2b1b9ecba 100644 --- a/docs/Classes/SDLImage.html +++ b/docs/Classes/SDLImage.html @@ -4,10 +4,14 @@ <ul> <li><a href="#section--initWithName:ofType:">-initWithName:ofType:</a></li> + <li><a href="#section--initWithName:ofType:isTemplate:">-initWithName:ofType:isTemplate:</a></li> <li><a href="#section--initWithName:">-initWithName:</a></li> + <li><a href="#section--initWithName:isTemplate:">-initWithName:isTemplate:</a></li> <li><a href="#section--initWithStaticImageValue:">-initWithStaticImageValue:</a></li> + <li><a href="#section--initWithStaticIconName:">-initWithStaticIconName:</a></li> <li><a href="#section-value">value</a></li> <li><a href="#section-imageType">imageType</a></li> + <li><a href="#section-isTemplate">isTemplate</a></li> </ul> <h3>Overview</h3> @@ -22,12 +26,13 @@ -initWithName:ofType: </h3> - <p>Undocumented</p> + <p>Convenience init for displaying a dynamic image. The image must be uploaded to SDL Core before being displayed.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">ofType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">)</span><span class="nv">imageType</span><span class="p">;</span></code></pre> + <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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">ofType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">)</span><span class="nv">imageType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,17 +40,61 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The unique name used to upload the image to SDL Core</p></dd> + <dt>imageType</dt> + <dd><p>Describes whether the image is static or dynamic</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLImage object</p> + </div> + + <h3 id="section--initWithName:ofType:isTemplate:"> + -initWithName:ofType:isTemplate: + </h3> + + <p>Convenience init for displaying a dynamic image. The image must be uploaded to SDL Core before being displayed.</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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">ofType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">)</span><span class="nv">imageType</span> + <span class="nf">isTemplate</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isTemplate</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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">ofType</span> <span class="nv">imageType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span><span class="p">,</span> <span class="nv">isTemplate</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The unique name used to upload the image to SDL Core</p></dd> + <dt>imageType</dt> + <dd><p>Describes whether the image is static or dynamic</p></dd> + <dt>isTemplate</dt> + <dd><p>Whether or not the image is a template that can be (re)colored by the SDL HMI. Static images are templates by default.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLImage object</p> + </div> <h3 id="section--initWithName:"> -initWithName: </h3> - <p>Undocumented</p> + <p>Convenience init for displaying a dynamic image. The image must be uploaded to SDL Core before being displayed.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> + <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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -53,17 +102,56 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The unique name used to upload the image to SDL Core</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLImage object</p> + </div> + + <h3 id="section--initWithName:isTemplate:"> + -initWithName:isTemplate: + </h3> + + <p>Convenience init for displaying a dynamic image. The image must be uploaded to SDL Core before being displayed.</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">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">isTemplate</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isTemplate</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">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">isTemplate</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The unique name used to upload the image to SDL Core</p></dd> + <dt>isTemplate</dt> + <dd><p>Whether or not the image is a template that can be (re)colored by the SDL HMI</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLImage object</p> + </div> <h3 id="section--initWithStaticImageValue:"> -initWithStaticImageValue: </h3> - <p>Undocumented</p> + <p>Convenience init for displaying a static image. Static images are already on-board SDL Core and can be used by providing the image’s value.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithStaticImageValue</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">staticImageValue</span><span class="p">;</span></code></pre> + <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">initWithStaticImageValue</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">staticImageValue</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -71,6 +159,43 @@ + <h4>Parameters</h4> + <dl> + <dt>staticImageValue</dt> + <dd><p>The image value assigned to the static image</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLImage object</p> + </div> + + <h3 id="section--initWithStaticIconName:"> + -initWithStaticIconName: + </h3> + + <p>Convenience init for displaying a static image. Static images are already on-board SDL Core and can be used by providing the image’s value.</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">initWithStaticIconName</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLStaticIconName.h@T@SDLStaticIconName">SDLStaticIconName</a></span><span class="p">)</span><span class="nv">staticIconName</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">staticIconName</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLStaticIconName.h@T@SDLStaticIconName">SDLStaticIconName</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>staticIconName</dt> + <dd><p>A SDLStaticIconName value</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLImage object</p> + </div> <h3 id="section-value"> value @@ -112,4 +237,22 @@ + <h3 id="section-isTemplate"> + isTemplate + </h3> + + <p>Indicates that this image can be (re)colored by the HMI to best fit the current color scheme.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</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)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">isTemplate</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">unowned(unsafe)</span> <span class="k">var</span> <span class="nv">isTemplate</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + </section> |