Home | History | Annotate | Download | only in docs
      1 #Topic MemoryStream
      2 #Alias MemoryStream_Reference ##
      3 
      4 #Class SkMemoryStream
      5 
      6 #Code
      7 #Populate
      8 ##
      9 
     10 # ------------------------------------------------------------------------------
     11 
     12 #Method SkMemoryStream()
     13 #In Constructors
     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)
     29 #In Constructors
     30 #Line # incomplete ##
     31 
     32 Allocates memory for stream data. Call getMemoryBase() to access allocated
     33 memory.
     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)
     50 #In Constructors
     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)
     72 #In Constructors
     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 sk_sp<SkData> asData() const
    177 #In incomplete
    178 #Line # incomplete ##
    179 
    180 #Return incomplete ##
    181 
    182 #Example
    183 // incomplete
    184 ##
    185 
    186 #SeeAlso incomplete
    187 
    188 #Method ##
    189 
    190 # ------------------------------------------------------------------------------
    191 
    192 #Method void setData(sk_sp<SkData> data)
    193 #In incomplete
    194 #Line # incomplete ##
    195 
    196 #Param data  incomplete ##
    197 
    198 #Example
    199 // incomplete
    200 ##
    201 
    202 #SeeAlso incomplete
    203 
    204 #Method ##
    205 
    206 # ------------------------------------------------------------------------------
    207 
    208 #Method void skipToAlign4()
    209 #In incomplete
    210 #Line # incomplete ##
    211 
    212 #Example
    213 // incomplete
    214 ##
    215 
    216 #SeeAlso incomplete
    217 
    218 #Method ##
    219 
    220 # ------------------------------------------------------------------------------
    221 
    222 #Method const void* getAtPos()
    223 #In incomplete
    224 #Line # incomplete ##
    225 
    226 #Return incomplete ##
    227 
    228 #Example
    229 // incomplete
    230 ##
    231 
    232 #SeeAlso incomplete
    233 
    234 #Method ##
    235 
    236 # ------------------------------------------------------------------------------
    237 
    238 #Method size_t read(void* buffer, size_t size) override
    239 #In incomplete
    240 #Line # incomplete ##
    241 
    242 #Param buffer  incomplete ##
    243 #Param size  incomplete ##
    244 
    245 #Return incomplete ##
    246 
    247 #Example
    248 // incomplete
    249 ##
    250 
    251 #SeeAlso incomplete
    252 
    253 #Method ##
    254 
    255 # ------------------------------------------------------------------------------
    256 
    257 #Method bool isAtEnd() const override
    258 #In incomplete
    259 #Line # incomplete ##
    260 
    261 #Return incomplete ##
    262 
    263 #Example
    264 // incomplete
    265 ##
    266 
    267 #SeeAlso incomplete
    268 
    269 #Method ##
    270 
    271 # ------------------------------------------------------------------------------
    272 
    273 #Method size_t peek(void* buffer, size_t size) const override
    274 #In incomplete
    275 #Line # incomplete ##
    276 
    277 #Param buffer  incomplete ##
    278 #Param size  incomplete ##
    279 
    280 #Return incomplete ##
    281 
    282 #Example
    283 // incomplete
    284 ##
    285 
    286 #SeeAlso incomplete
    287 
    288 #Method ##
    289 
    290 # ------------------------------------------------------------------------------
    291 
    292 #Method bool rewind() override
    293 #In incomplete
    294 #Line # incomplete ##
    295 
    296 #Return incomplete ##
    297 
    298 #Example
    299 // incomplete
    300 ##
    301 
    302 #SeeAlso incomplete
    303 
    304 #Method ##
    305 
    306 # ------------------------------------------------------------------------------
    307 
    308 #Method std::unique_ptr<SkMemoryStream> duplicate() const
    309 #In incomplete
    310 #Line # incomplete ##
    311 
    312 #Return incomplete ##
    313 
    314 #Example
    315 // incomplete
    316 ##
    317 
    318 #SeeAlso incomplete
    319 
    320 #Method ##
    321 
    322 # ------------------------------------------------------------------------------
    323 
    324 #Method size_t getPosition() const override
    325 #In incomplete
    326 #Line # incomplete ##
    327 
    328 #Return incomplete ##
    329 
    330 #Example
    331 // incomplete
    332 ##
    333 
    334 #SeeAlso incomplete
    335 
    336 #Method ##
    337 
    338 # ------------------------------------------------------------------------------
    339 
    340 #Method bool seek(size_t position) override
    341 #In incomplete
    342 #Line # incomplete ##
    343 
    344 #Param position  incomplete ##
    345 
    346 #Return incomplete ##
    347 
    348 #Example
    349 // incomplete
    350 ##
    351 
    352 #SeeAlso incomplete
    353 
    354 #Method ##
    355 
    356 # ------------------------------------------------------------------------------
    357 
    358 #Method bool move(long offset) override
    359 #In incomplete
    360 #Line # incomplete ##
    361 
    362 #Param offset  incomplete ##
    363 
    364 #Return incomplete ##
    365 
    366 #Example
    367 // incomplete
    368 ##
    369 
    370 #SeeAlso incomplete
    371 
    372 #Method ##
    373 
    374 # ------------------------------------------------------------------------------
    375 
    376 #Method std::unique_ptr<SkMemoryStream> fork() const
    377 #In incomplete
    378 #Line # incomplete ##
    379 
    380 #Return incomplete ##
    381 
    382 #Example
    383 // incomplete
    384 ##
    385 
    386 #SeeAlso incomplete
    387 
    388 #Method ##
    389 
    390 # ------------------------------------------------------------------------------
    391 
    392 #Method size_t getLength() const override
    393 #In incomplete
    394 #Line # incomplete ##
    395 
    396 #Return incomplete ##
    397 
    398 #Example
    399 // incomplete
    400 ##
    401 
    402 #SeeAlso incomplete
    403 
    404 #Method ##
    405 
    406 # ------------------------------------------------------------------------------
    407 
    408 #Method const void* getMemoryBase() override
    409 #In incomplete
    410 #Line # incomplete ##
    411 
    412 #Return incomplete ##
    413 
    414 #Example
    415 // incomplete
    416 ##
    417 
    418 #SeeAlso incomplete
    419 
    420 #Method ##
    421 
    422 #Class SkMemoryStream ##
    423 
    424 #Topic MemoryStream ##
    425