Package org.lwjgl.util.nfd

Class NFDPickFolderArgs

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<NFDPickFolderArgs>

org.lwjgl.util.nfd.NFDPickFolderArgs

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class NFDPickFolderArgs
extends Struct<NFDPickFolderArgs>
implements NativeResource

 struct nfdpickfolderu8args_t {
     nfdchar_t const * defaultPath;
     nfdwindowhandle_t parentWindow;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NFDPickFolderArgs.Buffer	An array of NFDPickFolderArgs structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

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

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DEFAULTPATH	The struct member offsets.
static final int	PARENTWINDOW	The struct member offsets.
static final 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	Description
NFDPickFolderArgs(ByteBuffer container)	Creates a NFDPickFolderArgs instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static NFDPickFolderArgs	calloc()	Returns a new NFDPickFolderArgs instance allocated with memCalloc.
static NFDPickFolderArgs.Buffer	calloc(int capacity)	Returns a new NFDPickFolderArgs.Buffer instance allocated with memCalloc.
static NFDPickFolderArgs.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new NFDPickFolderArgs.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static NFDPickFolderArgs	calloc(MemoryStack stack)	Returns a new NFDPickFolderArgs instance allocated on the specified MemoryStack and initializes all its bits to zero.
static NFDPickFolderArgs	create()	Returns a new NFDPickFolderArgs instance allocated with BufferUtils.
static NFDPickFolderArgs.Buffer	create(int capacity)	Returns a new NFDPickFolderArgs.Buffer instance allocated with BufferUtils.
static NFDPickFolderArgs	create(long address)	Returns a new NFDPickFolderArgs instance for the specified memory address.
static NFDPickFolderArgs.Buffer	create(long address, int capacity)	Create a NFDPickFolderArgs.Buffer instance at the specified memory.
static @Nullable NFDPickFolderArgs	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable NFDPickFolderArgs.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
@Nullable ByteBuffer	defaultPath()
NFDPickFolderArgs	defaultPath(@Nullable ByteBuffer value)	Sets the address of the specified encoded string to the defaultPath field.
@Nullable String	defaultPathString()
static NFDPickFolderArgs	malloc()	Returns a new NFDPickFolderArgs instance allocated with memAlloc.
static NFDPickFolderArgs.Buffer	malloc(int capacity)	Returns a new NFDPickFolderArgs.Buffer instance allocated with memAlloc.
static NFDPickFolderArgs.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new NFDPickFolderArgs.Buffer instance allocated on the specified MemoryStack.
static NFDPickFolderArgs	malloc(MemoryStack stack)	Returns a new NFDPickFolderArgs instance allocated on the specified MemoryStack.
static @Nullable ByteBuffer	ndefaultPath(long struct)	Unsafe version of defaultPath().
static void	ndefaultPath(long struct, @Nullable ByteBuffer value)	Unsafe version of defaultPath.
static @Nullable String	ndefaultPathString(long struct)	Unsafe version of defaultPathString().
static NFDWindowHandle	nparentWindow(long struct)	Unsafe version of parentWindow().
static void	nparentWindow(long struct, NFDWindowHandle value)	Unsafe version of parentWindow.
NFDWindowHandle	parentWindow()
NFDPickFolderArgs	parentWindow(Consumer<NFDWindowHandle> consumer)	Passes the parentWindow field to the specified Consumer.
NFDPickFolderArgs	parentWindow(NFDWindowHandle value)	Copies the specified NFDWindowHandle to the parentWindow field.
NFDPickFolderArgs	set(@Nullable ByteBuffer defaultPath, NFDWindowHandle parentWindow)	Initializes this struct with the specified values.
NFDPickFolderArgs	set(NFDPickFolderArgs src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

DEFAULTPATH

public static final int DEFAULTPATH

The struct member offsets.

PARENTWINDOW

public static final int PARENTWINDOW

The struct member offsets.

Constructor Details

NFDPickFolderArgs

public NFDPickFolderArgs(ByteBuffer container)

Creates a NFDPickFolderArgs 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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<NFDPickFolderArgs>

defaultPath

public @Nullable ByteBuffer defaultPath()

Returns:

a ByteBuffer view of the null-terminated string pointed to by the defaultPath field.

defaultPathString

public @Nullable String defaultPathString()

Returns:

the null-terminated string pointed to by the defaultPath field.

parentWindow

public NFDWindowHandle parentWindow()

Returns:

a NFDWindowHandle view of the parentWindow field.

defaultPath

public NFDPickFolderArgs defaultPath(@Nullable ByteBuffer value)

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

parentWindow

public NFDPickFolderArgs parentWindow(NFDWindowHandle value)

Copies the specified NFDWindowHandle to the parentWindow field.

parentWindow

public NFDPickFolderArgs parentWindow(Consumer<NFDWindowHandle> consumer)

Passes the parentWindow field to the specified Consumer.

set

public NFDPickFolderArgs set(@Nullable ByteBuffer defaultPath,
 NFDWindowHandle parentWindow)

Initializes this struct with the specified values.

set

public NFDPickFolderArgs set(NFDPickFolderArgs src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static NFDPickFolderArgs malloc()

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

calloc

public static NFDPickFolderArgs calloc()

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

create

public static NFDPickFolderArgs create()

Returns a new NFDPickFolderArgs instance allocated with BufferUtils.

create

public static NFDPickFolderArgs create(long address)

Returns a new NFDPickFolderArgs instance for the specified memory address.

createSafe

public static @Nullable NFDPickFolderArgs createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static NFDPickFolderArgs.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static NFDPickFolderArgs.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static NFDPickFolderArgs.Buffer create(int capacity)

Returns a new NFDPickFolderArgs.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static NFDPickFolderArgs.Buffer create(long address,
 int capacity)

Create a NFDPickFolderArgs.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable NFDPickFolderArgs.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static NFDPickFolderArgs malloc(MemoryStack stack)

Returns a new NFDPickFolderArgs instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static NFDPickFolderArgs calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static NFDPickFolderArgs.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static NFDPickFolderArgs.Buffer calloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ndefaultPath

public static @Nullable ByteBuffer ndefaultPath(long struct)

Unsafe version of defaultPath().

ndefaultPathString

public static @Nullable String ndefaultPathString(long struct)

Unsafe version of defaultPathString().

nparentWindow

public static NFDWindowHandle nparentWindow(long struct)

Unsafe version of parentWindow().

ndefaultPath

public static void ndefaultPath(long struct,
 @Nullable ByteBuffer value)

Unsafe version of defaultPath.

nparentWindow

public static void nparentWindow(long struct,
 NFDWindowHandle value)

Unsafe version of parentWindow.