summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLImageType.html
blob: 2f97e7baba154ba510b1972e3c8f91c0ad968e7e (plain)
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
<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>