| Cary Clark | d2ca79c | 2018-08-10 13:09:13 -0400 | [diff] [blame] | 1 | #Topic DynamicMemoryWStream |
| 2 | #Alias DynamicMemoryWStream_Reference ## |
| 3 | |
| 4 | #Class SkDynamicMemoryWStream |
| 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 SkDynamicMemoryWStream() |
| 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 ~SkDynamicMemoryWStream() override |
| 37 | #In Constructor |
| 38 | #Line # incomplete ## |
| 39 | |
| 40 | #Example |
| 41 | // incomplete |
| 42 | ## |
| 43 | |
| 44 | #SeeAlso incomplete |
| 45 | |
| 46 | #Method ## |
| 47 | |
| 48 | # ------------------------------------------------------------------------------ |
| 49 | |
| 50 | #Method bool write(const void* buffer, size_t size) override |
| 51 | #In incomplete |
| 52 | #Line # incomplete ## |
| 53 | |
| 54 | #Param buffer incomplete ## |
| 55 | #Param size incomplete ## |
| 56 | |
| 57 | #Return incomplete ## |
| 58 | |
| 59 | #Example |
| 60 | // incomplete |
| 61 | ## |
| 62 | |
| 63 | #SeeAlso incomplete |
| 64 | |
| 65 | #Method ## |
| 66 | |
| 67 | # ------------------------------------------------------------------------------ |
| 68 | |
| 69 | #Method size_t bytesWritten() const override |
| 70 | #In incomplete |
| 71 | #Line # incomplete ## |
| 72 | |
| 73 | #Return incomplete ## |
| 74 | |
| 75 | #Example |
| 76 | // incomplete |
| 77 | ## |
| 78 | |
| 79 | #SeeAlso incomplete |
| 80 | |
| 81 | #Method ## |
| 82 | |
| 83 | # ------------------------------------------------------------------------------ |
| 84 | |
| 85 | #Method bool read(void* buffer, size_t offset, size_t size) |
| 86 | #In incomplete |
| 87 | #Line # incomplete ## |
| 88 | |
| 89 | #Param buffer incomplete ## |
| 90 | #Param offset incomplete ## |
| 91 | #Param size incomplete ## |
| 92 | |
| 93 | #Return incomplete ## |
| 94 | |
| 95 | #Example |
| 96 | // incomplete |
| 97 | ## |
| 98 | |
| 99 | #SeeAlso incomplete |
| 100 | |
| 101 | #Method ## |
| 102 | |
| 103 | # ------------------------------------------------------------------------------ |
| 104 | |
| 105 | #Method void copyTo(void* dst) const |
| 106 | #In incomplete |
| 107 | #Line # incomplete ## |
| 108 | |
| 109 | Copies bytes read to dst. |
| 110 | |
| 111 | #Param dst incomplete ## |
| 112 | |
| 113 | #Example |
| 114 | // incomplete |
| 115 | ## |
| 116 | |
| 117 | #SeeAlso incomplete |
| 118 | |
| 119 | #Method ## |
| 120 | |
| 121 | # ------------------------------------------------------------------------------ |
| 122 | |
| 123 | #Method bool writeToStream(SkWStream* dst) const |
| 124 | #In incomplete |
| 125 | #Line # incomplete ## |
| 126 | |
| 127 | #Param dst incomplete ## |
| 128 | |
| 129 | #Return incomplete ## |
| 130 | |
| 131 | #Example |
| 132 | // incomplete |
| 133 | ## |
| 134 | |
| 135 | #SeeAlso incomplete |
| 136 | |
| 137 | #Method ## |
| 138 | |
| 139 | # ------------------------------------------------------------------------------ |
| 140 | |
| 141 | #Method void copyToAndReset(void* dst) |
| 142 | #In incomplete |
| 143 | #Line # incomplete ## |
| 144 | |
| 145 | Copies bytes read to dst, and resets stream to start. |
| 146 | Internally, frees memory as it is copied, reducing total memory |
| 147 | use on large streams. |
| 148 | |
| 149 | #Param dst incomplete ## |
| 150 | |
| 151 | #Example |
| 152 | // incomplete |
| 153 | ## |
| 154 | |
| 155 | #SeeAlso incomplete |
| 156 | |
| 157 | #Method ## |
| 158 | |
| 159 | # ------------------------------------------------------------------------------ |
| 160 | |
| 161 | #Method bool writeToAndReset(SkWStream* dst) |
| 162 | #In incomplete |
| 163 | #Line # incomplete ## |
| 164 | |
| 165 | Writes bytes read to dst, and resets stream to start. |
| 166 | Internally, frees memory as it is copied, reducing total memory |
| 167 | use on large streams. |
| 168 | |
| 169 | Stream is reset: data memory is released and stream length is set to zero; |
| 170 | regardless of whether the write was successful. |
| 171 | |
| 172 | #Param dst incomplete ## |
| 173 | |
| 174 | #Return incomplete ## |
| 175 | |
| 176 | #Example |
| 177 | // incomplete |
| 178 | ## |
| 179 | |
| 180 | #SeeAlso incomplete |
| 181 | |
| 182 | #Method ## |
| 183 | |
| 184 | # ------------------------------------------------------------------------------ |
| 185 | |
| 186 | #Method sk_sp<SkData> detachAsData() |
| 187 | #In incomplete |
| 188 | #Line # incomplete ## |
| 189 | |
| 190 | Return the contents as SkData, and then reset the stream. |
| 191 | |
| 192 | #Return incomplete ## |
| 193 | |
| 194 | #Example |
| 195 | // incomplete |
| 196 | ## |
| 197 | |
| 198 | #SeeAlso incomplete |
| 199 | |
| 200 | #Method ## |
| 201 | |
| 202 | # ------------------------------------------------------------------------------ |
| 203 | |
| 204 | #Method std::unique_ptr<SkStreamAsset> detachAsStream() |
| 205 | #In incomplete |
| 206 | #Line # incomplete ## |
| 207 | |
| 208 | Reset, returning a reader stream with the current content. |
| 209 | |
| 210 | #Return incomplete ## |
| 211 | |
| 212 | #Example |
| 213 | // incomplete |
| 214 | ## |
| 215 | |
| 216 | #SeeAlso incomplete |
| 217 | |
| 218 | #Method ## |
| 219 | |
| 220 | # ------------------------------------------------------------------------------ |
| 221 | |
| 222 | #Method void reset() |
| 223 | #In incomplete |
| 224 | #Line # incomplete ## |
| 225 | |
| 226 | Reset the stream to its original, empty, state. |
| 227 | |
| 228 | #Example |
| 229 | // incomplete |
| 230 | ## |
| 231 | |
| 232 | #SeeAlso incomplete |
| 233 | |
| 234 | #Method ## |
| 235 | |
| 236 | # ------------------------------------------------------------------------------ |
| 237 | |
| 238 | #Method void padToAlign4() |
| 239 | #In incomplete |
| 240 | #Line # incomplete ## |
| 241 | |
| 242 | #Example |
| 243 | // incomplete |
| 244 | ## |
| 245 | |
| 246 | #SeeAlso incomplete |
| 247 | |
| 248 | #Method ## |
| 249 | |
| 250 | #Class SkDynamicMemoryWStream ## |
| 251 | |
| 252 | #Topic DynamicMemoryWStream ## |