Difference between revisions of "Buffer"
From GiderosMobile
(Created page with "__NOTOC__ <languages /> <!-- GIDEROSOBJ:Buffer --> '''<translate>Supported platforms</translate>:''' File:Platform android.pngFile:Platform ios.pngFile:Platform mac....") |
(language stuff) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
<!-- GIDEROSOBJ:Buffer --> | <!-- GIDEROSOBJ:Buffer --> | ||
| − | ''' | + | '''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/> |
| − | ''' | + | '''Available since:''' Gideros 2020.2<br/> |
| − | ''' | + | '''Inherits from:''' [[Object]]<br/> |
| − | === | + | === Description === |
The Buffer class acts as FIFO buffer with Gideros internal file system integration. | The Buffer class acts as FIFO buffer with Gideros internal file system integration. | ||
| − | At lua side, Buffers are created with a name, and data can be added or from them. | + | |
| + | At lua side, Buffers are created with a name, and data can be added or taken from them. | ||
| + | |||
Once created, buffer data can also be accessed by internal gideros functions that normally use files, such as textures or sounds. To do that pass '''|B|buffer.ext''' as the file name, where buffer.ext is that name of the buffer. | Once created, buffer data can also be accessed by internal gideros functions that normally use files, such as textures or sounds. To do that pass '''|B|buffer.ext''' as the file name, where buffer.ext is that name of the buffer. | ||
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === | + | === Methods === |
| − | [[ | + | [[Buffer.new]] ''creates a new Buffer object''<br/><!--GIDEROSMTD:Buffer.new(name) creates a new Buffer object--> |
| − | <!-- GIDEROSMTD:Buffer.new(name) creates a new Buffer object --> | + | [[Buffer:append]] ''adds data at the end of the buffer''<br/><!-- GIDEROSMTD:Buffer:append(data) adds data at the end of the buffer--> |
| − | [[ | + | [[Buffer:prepend]] ''adds data at the beginning of the buffer''<br/><!--GIDEROSMTD:Buffer:prepend(data) adds data at the beginning of the buffer--> |
| − | <!-- GIDEROSMTD:Buffer:append(data) adds data at the end of the buffer --> | + | [[Buffer:trim]] ''removes data from the start or the end of the buffer''<br/><!--GIDEROSMTD:Buffer:trim(amount) removes data from the start or the end of the buffer--> |
| − | [[ | + | [[Buffer:set]] ''sets data in the buffer''<br/><!--GIDEROSMTD:Buffer:set(data,offset) sets data in the buffer--> |
| − | <!-- GIDEROSMTD:Buffer:prepend(data) adds data at the beginning of the buffer --> | + | [[Buffer:get]] ''gets data from the buffer''<br/><!--GIDEROSMTD:Buffer:get(offset,size) gets data from the buffer--> |
| − | [[ | + | [[Buffer:size]] ''gets the buffer size''<br/><!--GIDEROSMTD:Buffer:size() gets the buffer size--> |
| − | <!-- GIDEROSMTD:Buffer:trim(amount) | + | [[Buffer:seek]] ''sets the position of the next file access''<br/><!--GIDEROSMTD:Buffer:seek(offset) sets the position of the next file access--> |
| − | [[ | + | [[Buffer:tell]] ''gets the position of the next file access''<br/><!--GIDEROSMTD:Buffer:tell() gets the position of the next file access--> |
| − | <!-- GIDEROSMTD:Buffer:set(data,offset) sets data in the buffer --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Buffer:get(offset,size) gets data from the buffer --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Buffer:size() gets the buffer size --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Buffer:seek(offset) sets the position of the next file access --> | ||
| − | [[ | ||
| − | <!-- GIDEROSMTD:Buffer:tell() gets the position of the next file access --> | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === | + | === Events === |
| − | === | + | === Constants === |
|} | |} | ||
{{GIDEROS IMPORTANT LINKS}} | {{GIDEROS IMPORTANT LINKS}} | ||
Revision as of 01:09, 23 March 2022
Supported platforms: 
Available since: Gideros 2020.2
Inherits from: Object
Description
The Buffer class acts as FIFO buffer with Gideros internal file system integration.
At lua side, Buffers are created with a name, and data can be added or taken from them.
Once created, buffer data can also be accessed by internal gideros functions that normally use files, such as textures or sounds. To do that pass |B|buffer.ext as the file name, where buffer.ext is that name of the buffer.
MethodsBuffer.new creates a new Buffer object |
EventsConstants |
