Difference between revisions of "Data:getPointer"

 
m (Make LOVE in all caps.)
 
(10 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
+
Gets a pointer to the Data. Can be used with libraries such as LuaJIT's [http://luajit.org/ext_ffi.html FFI].
 
+
{{notice|Use at your own risk. Directly reading from and writing to the raw memory owned by the Data will bypass any safety checks and thread-safety the Data might normally have.}}
 +
{{notice|Since LÖVE [[11.3]], [[Data:getFFIPointer]] is a preferred alternative because it can work with new 64-bit architectures.}}
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
ptr, size = Data:getPointer( )
+
pointer = Data:getPointer( )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|pointer|ptr|A raw pointer to the Data.}}
+
{{param|light userdata|pointer|A raw pointer to the Data.}}
{{param|number|size|The size of the Data in bytes.}}
 
 
== See Also ==
 
== See Also ==
 
* [[parent::Data]]
 
* [[parent::Data]]
 +
* [[Data:getSize]]
 +
* [[Data:getString]]
 +
* [[Data:getFFIPointer]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Gets a pointer to the Data.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|Data:getPointer}}

Latest revision as of 13:58, 29 July 2020

Gets a pointer to the Data. Can be used with libraries such as LuaJIT's FFI.

O.png Use at your own risk. Directly reading from and writing to the raw memory owned by the Data will bypass any safety checks and thread-safety the Data might normally have.  


O.png Since LÖVE 11.3, Data:getFFIPointer is a preferred alternative because it can work with new 64-bit architectures.  


Function

Synopsis

pointer = Data:getPointer( )

Arguments

None.

Returns

light userdata pointer
A raw pointer to the Data.

See Also


Other Languages