summaryrefslogtreecommitdiff
path: root/docs/Enums/SDLLogLevel.html
blob: ed2bdd742ad203d1085c24cbc47bef18df400c0e (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
125
126
127
128
<h1>SDLLogLevel Enumeration Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-SDLLogLevelDefault">SDLLogLevelDefault</a></li>
  <li><a href="#section-SDLLogLevelOff">SDLLogLevelOff</a></li>
  <li><a href="#section-SDLLogLevelError">SDLLogLevelError</a></li>
  <li><a href="#section-SDLLogLevelWarning">SDLLogLevelWarning</a></li>
  <li><a href="#section-SDLLogLevelDebug">SDLLogLevelDebug</a></li>
  <li><a href="#section-SDLLogLevelVerbose">SDLLogLevelVerbose</a></li>
</ul>

<h3>Overview</h3>

<p>An enum describing a level of logging.</p>


<section class="section task-group-section">
  <h3 id="section-SDLLogLevelDefault">
      SDLLogLevelDefault
  </h3>
  
  <p>This is used to describe that a &ldquo;specific&rdquo; logging will instead use the global log level, for example, a module may use the global log level instead of its own by specifying this level.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLogLevelDefault</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="p">`</span><span class="nv">default</span><span class="p">`</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span></code></pre>

  
  
  
  <h3 id="section-SDLLogLevelOff">
      SDLLogLevelOff
  </h3>
  
  <p>This is used to describe a level that involves absolutely no logs being output.</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLogLevelOff</span> <span class="o">=</span> <span class="mi">0</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">off</span> <span class="o">=</span> <span class="mi">0</span></code></pre>

  
  
  
  <h3 id="section-SDLLogLevelError">
      SDLLogLevelError
  </h3>
  
  <p>Only error level logs will be output</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLogLevelError</span> <span class="o">=</span> <span class="n">SDLLogFlagError</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">error</span> <span class="o">=</span> <span class="mi">1</span></code></pre>

  
  
  
  <h3 id="section-SDLLogLevelWarning">
      SDLLogLevelWarning
  </h3>
  
  <p>Both error and warning level logs will be output</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLogLevelWarning</span> <span class="o">=</span> <span class="p">(</span><span class="n">SDLLogFlagError</span> <span class="o">|</span> <span class="n">SDLLogFlagWarning</span><span class="p">)</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">warning</span> <span class="o">=</span> <span class="mi">3</span></code></pre>

  
  
  
  <h3 id="section-SDLLogLevelDebug">
      SDLLogLevelDebug
  </h3>
  
  <p>Error, warning, and debug level logs will be output. This level will never be output in RELEASE environments</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLogLevelDebug</span> <span class="o">=</span> <span class="p">(</span><span class="n">SDLLogFlagWarning</span> <span class="o">|</span> <span class="n">SDLLogFlagDebug</span><span class="p">)</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">debug</span> <span class="o">=</span> <span class="mi">6</span></code></pre>

  
  
  
  <h3 id="section-SDLLogLevelVerbose">
      SDLLogLevelVerbose
  </h3>
  
  <p>All level logs will be output. This level will never be output in RELEASE environments</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="n">SDLLogLevelVerbose</span> <span class="o">=</span> <span class="p">(</span><span class="n">SDLLogFlagDebug</span> <span class="o">|</span> <span class="n">SDLLogFlagVerbose</span><span class="p">)</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">case</span> <span class="n">verbose</span> <span class="o">=</span> <span class="mi">12</span></code></pre>

  
  
  
</section>