| Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 1 | #Topic MemoryStream |
| 2 | #Alias MemoryStream_Reference ## |
| 3 | |
| 4 | #Class SkMemoryStream |
| 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 SkMemoryStream() |
| 21 | #In Constructor |
| 22 | #Line # incomplete ## |
| 23 | |
| 24 | #Return incomplete ## |
| 25 | |
| 26 | #Example |
| 27 | // incomplete |
| 28 | ## |
| 29 | |
| 30 | #SeeAlso incomplete |
| 31 | |
| 32 | #Method ## |
| 33 | |
| 34 | # ------------------------------------------------------------------------------ |
| 35 | |
| 36 | #Method SkMemoryStream(size_t length) |
| 37 | #In Constructor |
| 38 | #Line # incomplete ## |
| 39 | |
| 40 | We allocate (and free) the memory. Write to it via getMemoryBase() |
| 41 | |
| 42 | #Param length incomplete ## |
| 43 | |
| 44 | #Return incomplete ## |
| 45 | |
| 46 | #Example |
| 47 | // incomplete |
| 48 | ## |
| 49 | |
| 50 | #SeeAlso incomplete |
| 51 | |
| 52 | #Method ## |
| 53 | |
| 54 | # ------------------------------------------------------------------------------ |
| 55 | |
| 56 | #Method SkMemoryStream(const void* data, size_t length, bool copyData = false) |
| 57 | #In Constructor |
| 58 | #Line # incomplete ## |
| 59 | |
| 60 | If copyData is true, the stream makes a private copy of the data. |
| 61 | |
| 62 | #Param data incomplete ## |
| 63 | #Param length incomplete ## |
| 64 | #Param copyData incomplete ## |
| 65 | |
| 66 | #Return incomplete ## |
| 67 | |
| 68 | #Example |
| 69 | // incomplete |
| 70 | ## |
| 71 | |
| 72 | #SeeAlso incomplete |
| 73 | |
| 74 | #Method ## |
| 75 | |
| 76 | # ------------------------------------------------------------------------------ |
| 77 | |
| 78 | #Method SkMemoryStream(sk_sp<SkData> data) |
| 79 | #In Constructor |
| 80 | #Line # incomplete ## |
| 81 | |
| 82 | Creates the stream to read from the specified data |
| 83 | |
| 84 | #Param data incomplete ## |
| 85 | |
| 86 | #Return incomplete ## |
| 87 | |
| 88 | #Example |
| 89 | // incomplete |
| 90 | ## |
| 91 | |
| 92 | #SeeAlso incomplete |
| 93 | |
| 94 | #Method ## |
| 95 | |
| 96 | # ------------------------------------------------------------------------------ |
| 97 | |
| 98 | #Method static std::unique_ptr<SkMemoryStream> MakeCopy(const void* data, size_t length) |
| 99 | #In incomplete |
| 100 | #Line # incomplete ## |
| 101 | |
| 102 | Returns a stream with a copy of the input data. |
| 103 | |
| 104 | #Param data incomplete ## |
| 105 | #Param length incomplete ## |
| 106 | |
| 107 | #Return incomplete ## |
| 108 | |
| 109 | #Example |
| 110 | // incomplete |
| 111 | ## |
| 112 | |
| 113 | #SeeAlso incomplete |
| 114 | |
| 115 | #Method ## |
| 116 | |
| 117 | # ------------------------------------------------------------------------------ |
| 118 | |
| 119 | #Method static std::unique_ptr<SkMemoryStream> MakeDirect(const void* data, size_t length) |
| 120 | #In incomplete |
| 121 | #Line # incomplete ## |
| 122 | |
| 123 | Returns a stream with a bare pointer reference to the input data. |
| 124 | |
| 125 | #Param data incomplete ## |
| 126 | #Param length incomplete ## |
| 127 | |
| 128 | #Return incomplete ## |
| 129 | |
| 130 | #Example |
| 131 | // incomplete |
| 132 | ## |
| 133 | |
| 134 | #SeeAlso incomplete |
| 135 | |
| 136 | #Method ## |
| 137 | |
| 138 | # ------------------------------------------------------------------------------ |
| 139 | |
| 140 | #Method static std::unique_ptr<SkMemoryStream> Make(sk_sp<SkData> data) |
| 141 | #In incomplete |
| 142 | #Line # incomplete ## |
| 143 | |
| 144 | Returns a stream with a shared reference to the input data. |
| 145 | |
| 146 | #Param data incomplete ## |
| 147 | |
| 148 | #Return incomplete ## |
| 149 | |
| 150 | #Example |
| 151 | // incomplete |
| 152 | ## |
| 153 | |
| 154 | #SeeAlso incomplete |
| 155 | |
| 156 | #Method ## |
| 157 | |
| 158 | # ------------------------------------------------------------------------------ |
| 159 | |
| 160 | #Method virtual void setMemory(const void* data, size_t length, |
| 161 | bool copyData = false) |
| 162 | #In incomplete |
| 163 | #Line # incomplete ## |
| 164 | |
| 165 | Resets the stream to the specified data and length, |
| 166 | just like the constructor. |
| 167 | if copyData is true, the stream makes a private copy of the data |
| 168 | |
| 169 | #Param data incomplete ## |
| 170 | #Param length incomplete ## |
| 171 | #Param copyData incomplete ## |
| 172 | |
| 173 | #Example |
| 174 | // incomplete |
| 175 | ## |
| 176 | |
| 177 | #SeeAlso incomplete |
| 178 | |
| 179 | #Method ## |
| 180 | |
| 181 | # ------------------------------------------------------------------------------ |
| 182 | |
| 183 | #Method void setMemoryOwned(const void* data, size_t length) |
| 184 | #In incomplete |
| 185 | #Line # incomplete ## |
| 186 | |
| 187 | #Private |
| 188 | ## |
| 189 | |
| 190 | #Param data incomplete ## |
| 191 | #Param length incomplete ## |
| 192 | |
| 193 | #Example |
| 194 | // incomplete |
| 195 | ## |
| 196 | |
| 197 | #SeeAlso incomplete |
| 198 | |
| 199 | #Method ## |
| 200 | |
| 201 | # ------------------------------------------------------------------------------ |
| 202 | |
| 203 | #Method sk_sp<SkData> asData() const |
| 204 | #In incomplete |
| 205 | #Line # incomplete ## |
| 206 | |
| 207 | #Return incomplete ## |
| 208 | |
| 209 | #Example |
| 210 | // incomplete |
| 211 | ## |
| 212 | |
| 213 | #SeeAlso incomplete |
| 214 | |
| 215 | #Method ## |
| 216 | |
| 217 | # ------------------------------------------------------------------------------ |
| 218 | |
| 219 | #Method void setData(sk_sp<SkData> data) |
| 220 | #In incomplete |
| 221 | #Line # incomplete ## |
| 222 | |
| 223 | #Param data incomplete ## |
| 224 | |
| 225 | #Example |
| 226 | // incomplete |
| 227 | ## |
| 228 | |
| 229 | #SeeAlso incomplete |
| 230 | |
| 231 | #Method ## |
| 232 | |
| 233 | # ------------------------------------------------------------------------------ |
| 234 | |
| 235 | #Method void skipToAlign4() |
| 236 | #In incomplete |
| 237 | #Line # incomplete ## |
| 238 | |
| 239 | #Example |
| 240 | // incomplete |
| 241 | ## |
| 242 | |
| 243 | #SeeAlso incomplete |
| 244 | |
| 245 | #Method ## |
| 246 | |
| 247 | # ------------------------------------------------------------------------------ |
| 248 | |
| 249 | #Method const void* getAtPos() |
| 250 | #In incomplete |
| 251 | #Line # incomplete ## |
| 252 | |
| 253 | #Return incomplete ## |
| 254 | |
| 255 | #Example |
| 256 | // incomplete |
| 257 | ## |
| 258 | |
| 259 | #SeeAlso incomplete |
| 260 | |
| 261 | #Method ## |
| 262 | |
| 263 | # ------------------------------------------------------------------------------ |
| 264 | |
| 265 | #Method size_t read(void* buffer, size_t size) override |
| 266 | #In incomplete |
| 267 | #Line # incomplete ## |
| 268 | |
| 269 | #Param buffer incomplete ## |
| 270 | #Param size incomplete ## |
| 271 | |
| 272 | #Return incomplete ## |
| 273 | |
| 274 | #Example |
| 275 | // incomplete |
| 276 | ## |
| 277 | |
| 278 | #SeeAlso incomplete |
| 279 | |
| 280 | #Method ## |
| 281 | |
| 282 | # ------------------------------------------------------------------------------ |
| 283 | |
| 284 | #Method bool isAtEnd() const override |
| 285 | #In incomplete |
| 286 | #Line # incomplete ## |
| 287 | |
| 288 | #Return incomplete ## |
| 289 | |
| 290 | #Example |
| 291 | // incomplete |
| 292 | ## |
| 293 | |
| 294 | #SeeAlso incomplete |
| 295 | |
| 296 | #Method ## |
| 297 | |
| 298 | # ------------------------------------------------------------------------------ |
| 299 | |
| 300 | #Method size_t peek(void* buffer, size_t size) const override |
| 301 | #In incomplete |
| 302 | #Line # incomplete ## |
| 303 | |
| 304 | #Param buffer incomplete ## |
| 305 | #Param size incomplete ## |
| 306 | |
| 307 | #Return incomplete ## |
| 308 | |
| 309 | #Example |
| 310 | // incomplete |
| 311 | ## |
| 312 | |
| 313 | #SeeAlso incomplete |
| 314 | |
| 315 | #Method ## |
| 316 | |
| 317 | # ------------------------------------------------------------------------------ |
| 318 | |
| 319 | #Method bool rewind() override |
| 320 | #In incomplete |
| 321 | #Line # incomplete ## |
| 322 | |
| 323 | #Return incomplete ## |
| 324 | |
| 325 | #Example |
| 326 | // incomplete |
| 327 | ## |
| 328 | |
| 329 | #SeeAlso incomplete |
| 330 | |
| 331 | #Method ## |
| 332 | |
| 333 | # ------------------------------------------------------------------------------ |
| 334 | |
| 335 | #Method std::unique_ptr<SkMemoryStream> duplicate() const |
| 336 | #In incomplete |
| 337 | #Line # incomplete ## |
| 338 | |
| 339 | #Return incomplete ## |
| 340 | |
| 341 | #Example |
| 342 | // incomplete |
| 343 | ## |
| 344 | |
| 345 | #SeeAlso incomplete |
| 346 | |
| 347 | #Method ## |
| 348 | |
| 349 | # ------------------------------------------------------------------------------ |
| 350 | |
| 351 | #Method size_t getPosition() const override |
| 352 | #In incomplete |
| 353 | #Line # incomplete ## |
| 354 | |
| 355 | #Return incomplete ## |
| 356 | |
| 357 | #Example |
| 358 | // incomplete |
| 359 | ## |
| 360 | |
| 361 | #SeeAlso incomplete |
| 362 | |
| 363 | #Method ## |
| 364 | |
| 365 | # ------------------------------------------------------------------------------ |
| 366 | |
| 367 | #Method bool seek(size_t position) override |
| 368 | #In incomplete |
| 369 | #Line # incomplete ## |
| 370 | |
| 371 | #Param position incomplete ## |
| 372 | |
| 373 | #Return incomplete ## |
| 374 | |
| 375 | #Example |
| 376 | // incomplete |
| 377 | ## |
| 378 | |
| 379 | #SeeAlso incomplete |
| 380 | |
| 381 | #Method ## |
| 382 | |
| 383 | # ------------------------------------------------------------------------------ |
| 384 | |
| 385 | #Method bool move(long offset) override |
| 386 | #In incomplete |
| 387 | #Line # incomplete ## |
| 388 | |
| 389 | #Param offset incomplete ## |
| 390 | |
| 391 | #Return incomplete ## |
| 392 | |
| 393 | #Example |
| 394 | // incomplete |
| 395 | ## |
| 396 | |
| 397 | #SeeAlso incomplete |
| 398 | |
| 399 | #Method ## |
| 400 | |
| 401 | # ------------------------------------------------------------------------------ |
| 402 | |
| 403 | #Method std::unique_ptr<SkMemoryStream> fork() const |
| 404 | #In incomplete |
| 405 | #Line # incomplete ## |
| 406 | |
| 407 | #Return incomplete ## |
| 408 | |
| 409 | #Example |
| 410 | // incomplete |
| 411 | ## |
| 412 | |
| 413 | #SeeAlso incomplete |
| 414 | |
| 415 | #Method ## |
| 416 | |
| 417 | # ------------------------------------------------------------------------------ |
| 418 | |
| 419 | #Method size_t getLength() const override |
| 420 | #In incomplete |
| 421 | #Line # incomplete ## |
| 422 | |
| 423 | #Return incomplete ## |
| 424 | |
| 425 | #Example |
| 426 | // incomplete |
| 427 | ## |
| 428 | |
| 429 | #SeeAlso incomplete |
| 430 | |
| 431 | #Method ## |
| 432 | |
| 433 | # ------------------------------------------------------------------------------ |
| 434 | |
| 435 | #Method const void* getMemoryBase() override |
| 436 | #In incomplete |
| 437 | #Line # incomplete ## |
| 438 | |
| 439 | #Return incomplete ## |
| 440 | |
| 441 | #Example |
| 442 | // incomplete |
| 443 | ## |
| 444 | |
| 445 | #SeeAlso incomplete |
| 446 | |
| 447 | #Method ## |
| 448 | |
| 449 | #Class SkMemoryStream ## |
| 450 | |
| 451 | #Topic MemoryStream ## |