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