Package org.lwjgl.nuklear
Class NkStr
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.nuklear.NkStr
-
- All Implemented Interfaces:
java.lang.AutoCloseable
,org.lwjgl.system.NativeResource
,org.lwjgl.system.Pointer
public class NkStr extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResource
Basic string buffer which is only used in context with the text editor to manage and manipulate dynamic or fixed size string content. This is NOT the default string handling method. The only instance you should have any contact with this API is if you interact with anNkTextEdit
object inside one of the copy and paste functions and even there only for more advanced cases.Member documentation
len
– in codepoints/runes/glyphs
Layout
struct nk_str {
struct nk_buffer
buffer; int len; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NkStr.Buffer
An array ofNkStr
structs.
-
Constructor Summary
Constructors Constructor Description NkStr(java.nio.ByteBuffer container)
Creates aNkStr
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description NkBuffer
buffer()
Returns aNkBuffer
view of thebuffer
field.static NkStr
calloc()
Returns a newNkStr
instance allocated withmemCalloc
.static NkStr.Buffer
calloc(int capacity)
Returns a newNkStr.Buffer
instance allocated withmemCalloc
.static NkStr
callocStack()
Returns a newNkStr
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static NkStr.Buffer
callocStack(int capacity)
Returns a newNkStr.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static NkStr.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newNkStr.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static NkStr
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newNkStr
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static NkStr
create()
Returns a newNkStr
instance allocated withBufferUtils
.static NkStr.Buffer
create(int capacity)
Returns a newNkStr.Buffer
instance allocated withBufferUtils
.static NkStr
create(long address)
Returns a newNkStr
instance for the specified memory address.static NkStr.Buffer
create(long address, int capacity)
Create aNkStr.Buffer
instance at the specified memory.static NkStr
createSafe(long address)
static NkStr.Buffer
createSafe(long address, int capacity)
int
len()
Returns the value of thelen
field.static NkStr
malloc()
Returns a newNkStr
instance allocated withmemAlloc
.static NkStr.Buffer
malloc(int capacity)
Returns a newNkStr.Buffer
instance allocated withmemAlloc
.static NkStr
mallocStack()
Returns a newNkStr
instance allocated on the thread-localMemoryStack
.static NkStr.Buffer
mallocStack(int capacity)
Returns a newNkStr.Buffer
instance allocated on the thread-localMemoryStack
.static NkStr.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newNkStr.Buffer
instance allocated on the specifiedMemoryStack
.static NkStr
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newNkStr
instance allocated on the specifiedMemoryStack
.static NkBuffer
nbuffer(long struct)
Unsafe version ofbuffer()
.static int
nlen(long struct)
Unsafe version oflen()
.int
sizeof()
-
-
-
Constructor Detail
-
NkStr
public NkStr(java.nio.ByteBuffer container)
Creates aNkStr
instance at the current position of the specifiedByteBuffer
container. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
len
public int len()
Returns the value of thelen
field.
-
malloc
public static NkStr malloc()
Returns a newNkStr
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static NkStr calloc()
Returns a newNkStr
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static NkStr create()
Returns a newNkStr
instance allocated withBufferUtils
.
-
create
public static NkStr create(long address)
Returns a newNkStr
instance for the specified memory address.
-
createSafe
@Nullable public static NkStr createSafe(long address)
-
malloc
public static NkStr.Buffer malloc(int capacity)
Returns a newNkStr.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static NkStr.Buffer calloc(int capacity)
Returns a newNkStr.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static NkStr.Buffer create(int capacity)
Returns a newNkStr.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static NkStr.Buffer create(long address, int capacity)
Create aNkStr.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
createSafe
@Nullable public static NkStr.Buffer createSafe(long address, int capacity)
-
mallocStack
public static NkStr mallocStack()
Returns a newNkStr
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static NkStr callocStack()
Returns a newNkStr
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static NkStr mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newNkStr
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static NkStr callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newNkStr
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static NkStr.Buffer mallocStack(int capacity)
Returns a newNkStr.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static NkStr.Buffer callocStack(int capacity)
Returns a newNkStr.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static NkStr.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newNkStr.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static NkStr.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newNkStr.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
nlen
public static int nlen(long struct)
Unsafe version oflen()
.
-
-