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