You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/reference/engine/classes/EditableImage.yaml
+23-31Lines changed: 23 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ description: |
29
29
property is set to a new asset ID.
30
30
31
31
#### Update Limitations
32
-
32
+
33
33
Only a single `Class.EditableImage` can be updated per frame on the display
34
34
side. For example, if you update three `Class.EditableImage` objects which are
35
35
currently being displayed, it will take three frames for all of them to be updated.
@@ -60,7 +60,7 @@ inherits:
60
60
- Object
61
61
tags:
62
62
- NotCreatable
63
-
deprecation_message: ''
63
+
deprecation_message: ""
64
64
properties:
65
65
- name: EditableImage.Size
66
66
summary: |
@@ -78,7 +78,7 @@ properties:
78
78
tags:
79
79
- ReadOnly
80
80
- NotReplicated
81
-
deprecation_message: ''
81
+
deprecation_message: ""
82
82
security:
83
83
read: None
84
84
write: None
@@ -91,16 +91,16 @@ properties:
91
91
writeCapabilities: []
92
92
methods:
93
93
- name: EditableImage:Destroy
94
-
summary: ''
94
+
summary: ""
95
95
description: |
96
96
Destroys the contents of the image, immediately reclaiming used memory.
97
97
code_samples: []
98
98
parameters: []
99
99
returns:
100
100
- type: void
101
-
summary: ''
101
+
summary: ""
102
102
tags: []
103
-
deprecation_message: ''
103
+
deprecation_message: ""
104
104
security: None
105
105
thread_safety: Unsafe
106
106
capabilities: []
@@ -145,9 +145,9 @@ methods:
145
145
added image.
146
146
returns:
147
147
- type: void
148
-
summary: ''
148
+
summary: ""
149
149
tags: []
150
-
deprecation_message: ''
150
+
deprecation_message: ""
151
151
security: None
152
152
thread_safety: Unsafe
153
153
capabilities: []
@@ -181,9 +181,9 @@ methods:
181
181
of the added image.
182
182
returns:
183
183
- type: void
184
-
summary: ''
184
+
summary: ""
185
185
tags: []
186
-
deprecation_message: ''
186
+
deprecation_message: ""
187
187
security: None
188
188
thread_safety: Unsafe
189
189
capabilities: []
@@ -235,9 +235,9 @@ methods:
235
235
image.
236
236
returns:
237
237
- type: void
238
-
summary: ''
238
+
summary: ""
239
239
tags: []
240
-
deprecation_message: ''
240
+
deprecation_message: ""
241
241
security: None
242
242
thread_safety: Unsafe
243
243
capabilities: []
@@ -295,9 +295,9 @@ methods:
295
295
(i.e. `Image.Size / 2`).
296
296
returns:
297
297
- type: void
298
-
summary: ''
298
+
summary: ""
299
299
tags: []
300
-
deprecation_message: ''
300
+
deprecation_message: ""
301
301
security: None
302
302
thread_safety: Unsafe
303
303
capabilities: []
@@ -338,9 +338,9 @@ methods:
338
338
added image.
339
339
returns:
340
340
- type: void
341
-
summary: ''
341
+
summary: ""
342
342
tags: []
343
-
deprecation_message: ''
343
+
deprecation_message: ""
344
344
security: None
345
345
thread_safety: Unsafe
346
346
capabilities: []
@@ -383,9 +383,9 @@ methods:
383
383
added image.
384
384
returns:
385
385
- type: void
386
-
summary: ''
386
+
summary: ""
387
387
tags: []
388
-
deprecation_message: ''
388
+
deprecation_message: ""
389
389
security: None
390
390
thread_safety: Unsafe
391
391
capabilities: []
@@ -394,11 +394,7 @@ methods:
394
394
summary: |
395
395
Reads a rectangular region of pixels into a buffer.
396
396
description: |
397
-
A version of `Class.EditableImage:ReadPixels()|ReadPixels()` that returns
398
-
a buffer instead of a table. Each number in the buffer is a single byte,
399
-
while each number in the table is 4 bytes, making
400
-
`Class.EditableImage:ReadPixelsBuffer()|ReadPixelsBuffer()` more
401
-
memory-efficient than `Class.EditableImage:ReadPixels()|ReadPixels()`.
397
+
Reads a rectangular region of pixels from an `Class.EditableImage` and returns it as a buffer. Each number in the buffer is a single byte, with pixels stored in a sequence of four bytes (red, green, blue, and alpha).
402
398
403
399
Note that this method uses alpha instead of transparency, unlike the
404
400
`Class.EditableImage` drawing methods.
@@ -423,7 +419,7 @@ methods:
423
419
`Size.X * Size.Y * 4` bytes.
424
420
tags:
425
421
- CustomLuaState
426
-
deprecation_message: ''
422
+
deprecation_message: ""
427
423
security: None
428
424
thread_safety: Safe
429
425
capabilities: []
@@ -432,11 +428,7 @@ methods:
432
428
summary: |
433
429
Writes a rectangular region of pixels into the image.
434
430
description: |
435
-
A version of `Class.EditableImage:WritePixels()|WritePixels()` that takes
436
-
a buffer instead of a table. Each number in the buffer is a single byte,
437
-
while each number in the table is 4 bytes, making
438
-
`Class.EditableImage:WritePixelsBuffer()|WritePixelsBuffer()` more
439
-
memory-efficient than `Class.EditableImage:WritePixels()|WritePixels()`.
431
+
Writes a rectangular region of pixels to an `Class.EditableImage` from a buffer. Each number in the buffer is a single byte, with pixels stored in a sequence of four bytes (red, green, blue, and alpha).
440
432
441
433
Note that this method uses alpha instead of transparency, unlike the
0 commit comments