Top Description Inners Fields Constructors Methods
org.lwjgl.llvm

public Class CXUnsavedFile

extends Struct<CXUnsavedFile>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct CXUnsavedFile
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Provides the contents of a file that has not yet been saved to disk.

Each CXUnsavedFile instance provides the name of a file on the system along with the current contents of that file that have not yet been saved to disk.

Layout


struct CXUnsavedFile {
    char const * Filename;
    char const * Contents;
    unsigned long Length;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CXUnsavedFile.Buffer

An array of CXUnsavedFile structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CONTENTS

The struct member offsets.

public static final int
FILENAME

The struct member offsets.

public static final int
LENGTH

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
CXUnsavedFile(long address, ByteBuffer container)

public
CXUnsavedFile(ByteBuffer container)

Creates a CXUnsavedFile instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static CXUnsavedFile
calloc()

Returns a new CXUnsavedFile instance allocated with memCalloc.

public static CXUnsavedFile.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new CXUnsavedFile.Buffer instance allocated with memCalloc.

public static CXUnsavedFile
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new CXUnsavedFile instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static CXUnsavedFile.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new CXUnsavedFile.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static CXUnsavedFile
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CXUnsavedFile
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CXUnsavedFile.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CXUnsavedFile.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public ByteBuffer
Contents()

a buffer containing the unsaved contents of this file

public CXUnsavedFile
Contents(ByteBuffer value)

Sets the address of the specified ByteBuffer to the Contents field.

protected CXUnsavedFile
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static CXUnsavedFile
create()

Returns a new CXUnsavedFile instance allocated with BufferUtils.

public static CXUnsavedFile
create(long address)

Returns a new CXUnsavedFile instance for the specified memory address.

public static CXUnsavedFile.Buffer
create(int
the buffer capacity
capacity
)

Returns a new CXUnsavedFile.Buffer instance allocated with BufferUtils.

public static CXUnsavedFile.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a CXUnsavedFile.Buffer instance at the specified memory.

public static CXUnsavedFile
createSafe(long address)

Like create, but returns null if address is NULL.

public static CXUnsavedFile.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public ByteBuffer
Filename()

the file whose contents have not yet been saved.

public CXUnsavedFile
Filename(ByteBuffer value)

Sets the address of the specified encoded string to the Filename field.

public String
FilenameString()

the file whose contents have not yet been saved.

public long
Length()

the length of the unsaved contents of this buffer

public static CXUnsavedFile
malloc()

Returns a new CXUnsavedFile instance allocated with memAlloc.

public static CXUnsavedFile.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new CXUnsavedFile.Buffer instance allocated with memAlloc.

public static CXUnsavedFile
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new CXUnsavedFile instance allocated on the specified MemoryStack.

public static CXUnsavedFile.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new CXUnsavedFile.Buffer instance allocated on the specified MemoryStack.

public static CXUnsavedFile
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static CXUnsavedFile
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static CXUnsavedFile.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static CXUnsavedFile.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
nContents(long struct)

Unsafe version of Contents.

public static void
nContents(long struct, ByteBuffer value)

Unsafe version of Contents.

public static ByteBuffer
nFilename(long struct)

Unsafe version of Filename.

public static void
nFilename(long struct, ByteBuffer value)

Unsafe version of Filename.

public static String
nFilenameString(long struct)

Unsafe version of FilenameString.

public static long
nLength(long struct)

Unsafe version of Length.

public static void
nLength(long struct, long value)

Sets the specified value to the Length field of the specified struct.

public CXUnsavedFile
set(ByteBuffer Filename, ByteBuffer Contents)

Initializes this struct with the specified values.

public CXUnsavedFile

Returns:

this struct
set
(CXUnsavedFile
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CONTENTSback to summary
public static final int CONTENTS

The struct member offsets.

FILENAMEback to summary
public static final int FILENAME

The struct member offsets.

LENGTHback to summary
public static final int LENGTH

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

CXUnsavedFileback to summary
protected CXUnsavedFile(long address, ByteBuffer container)
CXUnsavedFileback to summary
public CXUnsavedFile(ByteBuffer container)

Creates a CXUnsavedFile instance at the current position of the specified ByteBuffer 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

callocback to summary
public static CXUnsavedFile calloc()

Returns a new CXUnsavedFile instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static CXUnsavedFile.Buffer calloc(int capacity)

Returns a new CXUnsavedFile.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static CXUnsavedFile calloc(MemoryStack stack)

Returns a new CXUnsavedFile instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static CXUnsavedFile.Buffer calloc(int capacity, MemoryStack stack)

Returns a new CXUnsavedFile.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static CXUnsavedFile callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXUnsavedFile callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXUnsavedFile.Buffer callocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static CXUnsavedFile.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

Annotations
@Deprecated
Contentsback to summary
public ByteBuffer Contents()

a buffer containing the unsaved contents of this file

Annotations
@NativeType:char const *
Contentsback to summary
public CXUnsavedFile Contents(ByteBuffer value)

Sets the address of the specified ByteBuffer to the Contents field.

createback to summary
protected CXUnsavedFile create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static CXUnsavedFile create()

Returns a new CXUnsavedFile instance allocated with BufferUtils.

createback to summary
public static CXUnsavedFile create(long address)

Returns a new CXUnsavedFile instance for the specified memory address.

createback to summary
public static CXUnsavedFile.Buffer create(int capacity)

Returns a new CXUnsavedFile.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static CXUnsavedFile.Buffer create(long address, int capacity)

Create a CXUnsavedFile.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static CXUnsavedFile createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static CXUnsavedFile.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
Filenameback to summary
public ByteBuffer Filename()

the file whose contents have not yet been saved.

This file must already exist in the file system.

Annotations
@NativeType:char const *
Filenameback to summary
public CXUnsavedFile Filename(ByteBuffer value)

Sets the address of the specified encoded string to the Filename field.

FilenameStringback to summary
public String FilenameString()

the file whose contents have not yet been saved.

This file must already exist in the file system.

Annotations
@NativeType:char const *
Lengthback to summary
public long Length()

the length of the unsaved contents of this buffer

Annotations
@NativeType:unsigned long
mallocback to summary
public static CXUnsavedFile malloc()

Returns a new CXUnsavedFile instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static CXUnsavedFile.Buffer malloc(int capacity)

Returns a new CXUnsavedFile.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static CXUnsavedFile malloc(MemoryStack stack)

Returns a new CXUnsavedFile instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static CXUnsavedFile.Buffer malloc(int capacity, MemoryStack stack)

Returns a new CXUnsavedFile.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static CXUnsavedFile mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXUnsavedFile mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXUnsavedFile.Buffer mallocStack(int capacity)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static CXUnsavedFile.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

Annotations
@Deprecated
nContentsback to summary
public static ByteBuffer nContents(long struct)

Unsafe version of Contents.

nContentsback to summary
public static void nContents(long struct, ByteBuffer value)

Unsafe version of Contents.

nFilenameback to summary
public static ByteBuffer nFilename(long struct)

Unsafe version of Filename.

nFilenameback to summary
public static void nFilename(long struct, ByteBuffer value)

Unsafe version of Filename.

nFilenameStringback to summary
public static String nFilenameString(long struct)

Unsafe version of FilenameString.

nLengthback to summary
public static long nLength(long struct)

Unsafe version of Length.

nLengthback to summary
public static void nLength(long struct, long value)

Sets the specified value to the Length field of the specified struct.

setback to summary
public CXUnsavedFile set(ByteBuffer Filename, ByteBuffer Contents)

Initializes this struct with the specified values.

setback to summary
public CXUnsavedFile set(CXUnsavedFile src)

Copies the specified struct data to this struct.

Parameters
src:CXUnsavedFile

the source struct

Returns:CXUnsavedFile

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.llvm back to summary

public Class CXUnsavedFile.Buffer

extends StructBuffer<CXUnsavedFile, CXUnsavedFile.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of CXUnsavedFile structs.

Field Summary

Modifier and TypeField and Description
private static final CXUnsavedFile

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new CXUnsavedFile.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the CXUnsavedFile#Contents field.
Contents
()

public CXUnsavedFile.Buffer
Contents(ByteBuffer value)

Sets the address of the specified ByteBuffer to the CXUnsavedFile#Contents field.

public ByteBuffer

Returns:

a ByteBuffer view of the null-terminated string pointed to by the CXUnsavedFile#Filename field.
Filename
()

public CXUnsavedFile.Buffer
Filename(ByteBuffer value)

Sets the address of the specified encoded string to the CXUnsavedFile#Filename field.

public String

Returns:

the null-terminated string pointed to by the CXUnsavedFile#Filename field.
FilenameString
()

protected CXUnsavedFile
public long

Returns:

the value of the CXUnsavedFile#Length field.
Length
()

protected CXUnsavedFile.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final CXUnsavedFile ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new CXUnsavedFile.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by CXUnsavedFile#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

Contentsback to summary
public ByteBuffer Contents()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the CXUnsavedFile#Contents field.

Annotations
@NativeType:char const *
Contentsback to summary
public CXUnsavedFile.Buffer Contents(ByteBuffer value)

Sets the address of the specified ByteBuffer to the CXUnsavedFile#Contents field.

Filenameback to summary
public ByteBuffer Filename()
Returns:ByteBuffer

a ByteBuffer view of the null-terminated string pointed to by the CXUnsavedFile#Filename field.

Annotations
@NativeType:char const *
Filenameback to summary
public CXUnsavedFile.Buffer Filename(ByteBuffer value)

Sets the address of the specified encoded string to the CXUnsavedFile#Filename field.

FilenameStringback to summary
public String FilenameString()
Returns:String

the null-terminated string pointed to by the CXUnsavedFile#Filename field.

Annotations
@NativeType:char const *
getElementFactoryback to summary
protected CXUnsavedFile getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
Lengthback to summary
public long Length()
Returns:long

the value of the CXUnsavedFile#Length field.

Annotations
@NativeType:unsigned long
selfback to summary
protected CXUnsavedFile.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override