CXUnsavedFile (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.llvm.CXUnsavedFile

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class CXUnsavedFile
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
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.

Member documentation
- Filename – the file whose contents have not yet been saved.
  This file must already exist in the file system.
- Contents – a buffer containing the unsaved contents of this file
- Length – the length of the unsaved contents of this buffer
Layout
```
 struct CXUnsavedFile {
     char const * Filename;
     char const * Contents;
     unsigned long Length;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CXUnsavedFile.Buffer
An array of CXUnsavedFile structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CXUnsavedFile.Buffer` An array of `CXUnsavedFile` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CONTENTS` The struct member offsets.
`static int`	`FILENAME` The struct member offsets.
`static int`	`LENGTH` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

CXUnsavedFile(java.nio.ByteBuffer container)
Creates a CXUnsavedFile instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`CXUnsavedFile(java.nio.ByteBuffer container)` Creates a `CXUnsavedFile` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CXUnsavedFile`	`calloc()` Returns a new `CXUnsavedFile` instance allocated with `memCalloc`.
`static CXUnsavedFile.Buffer`	`calloc(int capacity)` Returns a new `CXUnsavedFile.Buffer` instance allocated with `memCalloc`.
`static CXUnsavedFile`	`callocStack()` Returns a new `CXUnsavedFile` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CXUnsavedFile.Buffer`	`callocStack(int capacity)` Returns a new `CXUnsavedFile.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static CXUnsavedFile.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CXUnsavedFile.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static CXUnsavedFile`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CXUnsavedFile` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`java.nio.ByteBuffer`	`Contents()` Returns a `ByteBuffer` view of the data pointed to by the `Contents` field.
`CXUnsavedFile`	`Contents(java.nio.ByteBuffer value)` Sets the address of the specified `ByteBuffer` to the `Contents` field.
`static CXUnsavedFile`	`create()` Returns a new `CXUnsavedFile` instance allocated with `BufferUtils`.
`static CXUnsavedFile.Buffer`	`create(int capacity)` Returns a new `CXUnsavedFile.Buffer` instance allocated with `BufferUtils`.
`static CXUnsavedFile`	`create(long address)` Returns a new `CXUnsavedFile` instance for the specified memory address.
`static CXUnsavedFile.Buffer`	`create(long address, int capacity)` Create a `CXUnsavedFile.Buffer` instance at the specified memory.
`static CXUnsavedFile`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CXUnsavedFile.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`java.nio.ByteBuffer`	`Filename()` Returns a `ByteBuffer` view of the null-terminated string pointed to by the `Filename` field.
`CXUnsavedFile`	`Filename(java.nio.ByteBuffer value)` Sets the address of the specified encoded string to the `Filename` field.
`java.lang.String`	`FilenameString()` Decodes the null-terminated string pointed to by the `Filename` field.
`long`	`Length()` Returns the value of the `Length` field.
`static CXUnsavedFile`	`malloc()` Returns a new `CXUnsavedFile` instance allocated with `memAlloc`.
`static CXUnsavedFile.Buffer`	`malloc(int capacity)` Returns a new `CXUnsavedFile.Buffer` instance allocated with `memAlloc`.
`static CXUnsavedFile`	`mallocStack()` Returns a new `CXUnsavedFile` instance allocated on the thread-local `MemoryStack`.
`static CXUnsavedFile.Buffer`	`mallocStack(int capacity)` Returns a new `CXUnsavedFile.Buffer` instance allocated on the thread-local `MemoryStack`.
`static CXUnsavedFile.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `CXUnsavedFile.Buffer` instance allocated on the specified `MemoryStack`.
`static CXUnsavedFile`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `CXUnsavedFile` instance allocated on the specified `MemoryStack`.
`static java.nio.ByteBuffer`	`nContents(long struct)` Unsafe version of `Contents`.
`static void`	`nContents(long struct, java.nio.ByteBuffer value)` Unsafe version of `Contents`.
`static java.nio.ByteBuffer`	`nFilename(long struct)` Unsafe version of `Filename()`.
`static void`	`nFilename(long struct, java.nio.ByteBuffer value)` Unsafe version of `Filename`.
`static java.lang.String`	`nFilenameString(long struct)` Unsafe version of `FilenameString()`.
`static long`	`nLength(long struct)` Unsafe version of `Length()`.
`static void`	`nLength(long struct, long value)` Sets the specified value to the `Length` field of the specified `struct`.
`CXUnsavedFile`	`set(java.nio.ByteBuffer Filename, java.nio.ByteBuffer Contents)` Initializes this struct with the specified values.
`CXUnsavedFile`	`set(CXUnsavedFile src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - FILENAME
```
public static final int FILENAME
```
    The struct member offsets.
  - CONTENTS
```
public static final int CONTENTS
```
    The struct member offsets.
  - LENGTH
```
public static final int LENGTH
```
    The struct member offsets.
- Constructor Detail
  - CXUnsavedFile
```
public CXUnsavedFile(java.nio.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
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - Filename
```
public java.nio.ByteBuffer Filename()
```
    Returns a ByteBuffer view of the null-terminated string pointed to by the Filename field.
  - FilenameString
```
public java.lang.String FilenameString()
```
    Decodes the null-terminated string pointed to by the Filename field.
  - Contents
```
public java.nio.ByteBuffer Contents()
```
    Returns a ByteBuffer view of the data pointed to by the Contents field.
  - Length
```
public long Length()
```
    Returns the value of the Length field.
  - Filename
```
public CXUnsavedFile Filename(java.nio.ByteBuffer value)
```
    Sets the address of the specified encoded string to the Filename field.
  - Contents
```
public CXUnsavedFile Contents(java.nio.ByteBuffer value)
```
    Sets the address of the specified ByteBuffer to the Contents field.
  - set
```
public CXUnsavedFile set(java.nio.ByteBuffer Filename,
                         java.nio.ByteBuffer Contents)
```
    Initializes this struct with the specified values.
  - set
```
public CXUnsavedFile set(CXUnsavedFile src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static CXUnsavedFile malloc()
```
    Returns a new CXUnsavedFile instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static CXUnsavedFile calloc()
```
    Returns a new CXUnsavedFile instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static CXUnsavedFile create()
```
    Returns a new CXUnsavedFile instance allocated with BufferUtils.
  - create
```
public static CXUnsavedFile create(long address)
```
    Returns a new CXUnsavedFile instance for the specified memory address.
  - createSafe
```
@Nullable
public static CXUnsavedFile createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static CXUnsavedFile.Buffer malloc(int capacity)
```
    Returns a new CXUnsavedFile.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static CXUnsavedFile.Buffer calloc(int capacity)
```
    Returns a new CXUnsavedFile.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CXUnsavedFile.Buffer create(int capacity)
```
    Returns a new CXUnsavedFile.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static CXUnsavedFile.Buffer create(long address,
                                          int capacity)
```
    Create a CXUnsavedFile.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CXUnsavedFile.Buffer createSafe(long address,
                                                        int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static CXUnsavedFile mallocStack()
```
    Returns a new CXUnsavedFile instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static CXUnsavedFile callocStack()
```
    Returns a new CXUnsavedFile instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static CXUnsavedFile mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXUnsavedFile instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static CXUnsavedFile callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXUnsavedFile instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static CXUnsavedFile.Buffer mallocStack(int capacity)
```
    Returns a new CXUnsavedFile.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static CXUnsavedFile.Buffer callocStack(int capacity)
```
    Returns a new CXUnsavedFile.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static CXUnsavedFile.Buffer mallocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXUnsavedFile.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static CXUnsavedFile.Buffer callocStack(int capacity,
                                               org.lwjgl.system.MemoryStack stack)
```
    Returns a new CXUnsavedFile.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nFilename
```
public static java.nio.ByteBuffer nFilename(long struct)
```
    Unsafe version of Filename().
  - nFilenameString
```
public static java.lang.String nFilenameString(long struct)
```
    Unsafe version of FilenameString().
  - nContents
```
public static java.nio.ByteBuffer nContents(long struct)
```
    Unsafe version of Contents.
  - nLength
```
public static long nLength(long struct)
```
    Unsafe version of Length().
  - nFilename
```
public static void nFilename(long struct,
                             java.nio.ByteBuffer value)
```
    Unsafe version of Filename.
  - nContents
```
public static void nContents(long struct,
                             java.nio.ByteBuffer value)
```
    Unsafe version of Contents.
  - nLength
```
public static void nLength(long struct,
                           long value)
```
    Sets the specified value to the Length field of the specified struct.
  - validate
```
public static void validate(long struct)
```
    Validates pointer members that should not be NULL.
    
    Parameters:
    
    struct - the struct to validate
  - validate
```
public static void validate(long array,
                            int count)
```
    Calls validate(long) for each struct contained in the specified struct array.
    
    Parameters:
    
    array - the struct array to validate
    
    count - the number of structs in array

Class CXUnsavedFile

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

FILENAME

CONTENTS

LENGTH

Constructor Detail

CXUnsavedFile

Method Detail

sizeof

Filename

FilenameString

Contents

Length

Filename

Contents

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nFilename

nFilenameString

nContents

nLength

nFilename

nContents

nLength

validate

validate