blob: 40c142b00cda6dfad3a25b18d63ced9f3677b193 [file] [log] [blame]
Cary Clarkd2ca79c2018-08-10 13:09:13 -04001#Topic WStream
2#Alias WStream_Reference ##
3
4#Class SkWStream
5
Cary Clark61313f32018-10-08 14:57:48 -04006#Code
Cary Clarkd2ca79c2018-08-10 13:09:13 -04007#Populate
8##
9
10# ------------------------------------------------------------------------------
11
12#Method virtual ~SkWStream()
Cary Clark61313f32018-10-08 14:57:48 -040013#In Constructors
Cary Clarkd2ca79c2018-08-10 13:09:13 -040014#Line # incomplete ##
15
16#Example
17// incomplete
18##
19
20#SeeAlso incomplete
21
22#Method ##
23
24# ------------------------------------------------------------------------------
25
26#Method SkWStream()
Cary Clark61313f32018-10-08 14:57:48 -040027#In Constructors
Cary Clarkd2ca79c2018-08-10 13:09:13 -040028#Line # incomplete ##
29
30#Return incomplete ##
31
32#Example
33// incomplete
34##
35
36#SeeAlso incomplete
37
38#Method ##
39
40# ------------------------------------------------------------------------------
41
42#Method virtual bool write(const void* buffer, size_t size) = 0
43#In incomplete
44#Line # incomplete ##
45
46Called to write bytes to a SkWStream. Returns true on success
47
48#Param buffer the address of at least size bytes to be written to the stream
49##
50#Param size number of bytes in buffer to write to the stream
51##
52
53#Return true on success
54##
55
56#Example
57// incomplete
58##
59
60#SeeAlso incomplete
61
62#Method ##
63
64# ------------------------------------------------------------------------------
65
66#Method virtual void flush()
67#In incomplete
68#Line # incomplete ##
69
70#Example
71// incomplete
72##
73
74#SeeAlso incomplete
75
76#Method ##
77
78# ------------------------------------------------------------------------------
79
80#Method virtual size_t bytesWritten() const = 0
81#In incomplete
82#Line # incomplete ##
83
84#Return incomplete ##
85
86#Example
87// incomplete
88##
89
90#SeeAlso incomplete
91
92#Method ##
93
94# ------------------------------------------------------------------------------
95
96#Method bool write8(U8CPU value)
97#In incomplete
98#Line # incomplete ##
99
100Helpers.
101
102#Param value incomplete ##
103
104#Return incomplete ##
105
106#Example
107// incomplete
108##
109
110#SeeAlso incomplete
111
112#Method ##
113
114# ------------------------------------------------------------------------------
115
116#Method bool write16(U16CPU value)
117#In incomplete
118#Line # incomplete ##
119
120#Param value incomplete ##
121
122#Return incomplete ##
123
124#Example
125// incomplete
126##
127
128#SeeAlso incomplete
129
130#Method ##
131
132# ------------------------------------------------------------------------------
133
134#Method bool write32(uint32_t v)
135#In incomplete
136#Line # incomplete ##
137
138#Param v incomplete ##
139
140#Return incomplete ##
141
142#Example
143// incomplete
144##
145
146#SeeAlso incomplete
147
148#Method ##
149
150# ------------------------------------------------------------------------------
151
152#Method bool writeText(const char text[])
153#In incomplete
154#Line # incomplete ##
155
156#Param text incomplete ##
157
158#Return incomplete ##
159
160#Example
161// incomplete
162##
163
164#SeeAlso incomplete
165
166#Method ##
167
168# ------------------------------------------------------------------------------
169
170#Method bool newline()
171#In incomplete
172#Line # incomplete ##
173
174#Return incomplete ##
175
176#Example
177// incomplete
178##
179
180#SeeAlso incomplete
181
182#Method ##
183
184# ------------------------------------------------------------------------------
185
186#Method bool writeDecAsText(int32_t)
187#In incomplete
188#Line # incomplete ##
189
190#Param t incomplete ##
191
192#Return incomplete ##
193
194#Example
195// incomplete
196##
197
198#SeeAlso incomplete
199
200#Method ##
201
202# ------------------------------------------------------------------------------
203
204#Method bool writeBigDecAsText(int64_t, int minDigits = 0)
205#In incomplete
206#Line # incomplete ##
207
208#Param t incomplete ##
209#Param minDigits incomplete ##
210
211#Return incomplete ##
212
213#Example
214// incomplete
215##
216
217#SeeAlso incomplete
218
219#Method ##
220
221# ------------------------------------------------------------------------------
222
223#Method bool writeHexAsText(uint32_t, int minDigits = 0)
224#In incomplete
225#Line # incomplete ##
226
227#Param t incomplete ##
228#Param minDigits incomplete ##
229
230#Return incomplete ##
231
232#Example
233// incomplete
234##
235
236#SeeAlso incomplete
237
238#Method ##
239
240# ------------------------------------------------------------------------------
241
242#Method bool writeScalarAsText(SkScalar)
243#In incomplete
244#Line # incomplete ##
245
246#Param SkScalar incomplete ##
247
248#Return incomplete ##
249
250#Example
251// incomplete
252##
253
254#SeeAlso incomplete
255
256#Method ##
257
258# ------------------------------------------------------------------------------
259
260#Method bool writeBool(bool v)
261#In incomplete
262#Line # incomplete ##
263
264#Param v incomplete ##
265
266#Return incomplete ##
267
268#Example
269// incomplete
270##
271
272#SeeAlso incomplete
273
274#Method ##
275
276# ------------------------------------------------------------------------------
277
278#Method bool writeScalar(SkScalar)
279#In incomplete
280#Line # incomplete ##
281
282#Param SkScalar incomplete ##
283
284#Return incomplete ##
285
286#Example
287// incomplete
288##
289
290#SeeAlso incomplete
291
292#Method ##
293
294# ------------------------------------------------------------------------------
295
296#Method bool writePackedUInt(size_t)
297#In incomplete
298#Line # incomplete ##
299
300#Param t incomplete ##
301
302#Return incomplete ##
303
304#Example
305// incomplete
306##
307
308#SeeAlso incomplete
309
310#Method ##
311
312# ------------------------------------------------------------------------------
313
314#Method bool writeStream(SkStream* input, size_t length)
315#In incomplete
316#Line # incomplete ##
317
318#Param input incomplete ##
319#Param length incomplete ##
320
321#Return incomplete ##
322
323#Example
324// incomplete
325##
326
327#SeeAlso incomplete
328
329#Method ##
330
331# ------------------------------------------------------------------------------
332
333#Method static int SizeOfPackedUInt(size_t value)
334#In incomplete
335#Line # incomplete ##
336
337This returns the number of bytes in the stream required to store
338'value'.
339
340#Param value incomplete ##
341
342#Return incomplete ##
343
344#Example
345// incomplete
346##
347
348#SeeAlso incomplete
349
350#Method ##
351
352#Class SkWStream ##
353
354#Topic WStream ##