Difference between revisions of "Buffer"

From GiderosMobile
(language stuff)
 
(One intermediate revision by the same user not shown)
Line 10: Line 10:
 
At lua side, Buffers are created with a name, and data can be added or taken 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 the name of the buffer.
  
 
{|-
 
{|-
Line 17: Line 17:
 
[[Buffer.new]] ''creates a new Buffer object''<br/><!--GIDEROSMTD:Buffer.new(name) creates a new Buffer object-->
 
[[Buffer.new]] ''creates a new Buffer object''<br/><!--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:append]] ''adds data at the end of the buffer''<br/><!-- GIDEROSMTD:Buffer:append(data) adds data at the end of the buffer-->
 +
[[Buffer:get]] ''gets data from the buffer''<br/><!--GIDEROSMTD:Buffer:get(offset,size) gets data from 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-->
 
[[Buffer:prepend]] ''adds data at the beginning of the buffer''<br/><!--GIDEROSMTD:Buffer:prepend(data) adds data at the beginning 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:seek]] ''sets the position of the next file access''<br/><!--GIDEROSMTD:Buffer:seek(offset) sets the position of the next file access-->
 
[[Buffer:set]] ''sets data in the buffer''<br/><!--GIDEROSMTD:Buffer:set(data,offset) sets data in the buffer-->
 
[[Buffer:set]] ''sets data in the buffer''<br/><!--GIDEROSMTD:Buffer:set(data,offset) sets data in 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-->
 
[[Buffer:size]] ''gets the buffer size''<br/><!--GIDEROSMTD:Buffer:size() gets the buffer size-->
[[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-->
 
[[Buffer:tell]] ''gets the position of the next file access''<br/><!--GIDEROSMTD:Buffer:tell() gets the position of the next file access-->
 +
[[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-->
  
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|

Latest revision as of 12:41, 12 March 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
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 the name of the buffer.

Methods

Buffer.new creates a new Buffer object
Buffer:append adds data at the end of the buffer
Buffer:get gets data from the buffer
Buffer:prepend adds data at the beginning of the buffer
Buffer:seek sets the position of the next file access
Buffer:set sets data in the buffer
Buffer:size gets the buffer size
Buffer:tell gets the position of the next file access
Buffer:trim removes data from the start or the end of the buffer

Events

Constants