Difference between revisions of "Data:getPointer"

m (Added notice about dangers)
(the page for Data:getFFIPointer says it should be used instead of getPointer, so I've added a notice here linking to Data:getFFIPointer)
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].
 
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|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 ===
Line 14: Line 15:
 
* [[Data:getSize]]
 
* [[Data:getSize]]
 
* [[Data:getString]]
 
* [[Data:getString]]
 +
* [[Data:getFFIPointer]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Gets a pointer to the Data.}}
 
{{#set:Description=Gets a pointer to the Data.}}

Revision as of 09:18, 21 February 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