Top Description Inners Fields Constructors Methods
org.lwjgl.system.windows

public Class DATA_BLOB

extends Struct<DATA_BLOB>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

The DATA_BLOB structure contains an arbitrary array of bytes.

Layout


struct DATA_BLOB {
    DWORD cbData;
    BYTE * pbData;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
DATA_BLOB.Buffer

An array of DATA_BLOB structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CBDATA

The struct member offsets.

public static final int
PBDATA

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
DATA_BLOB(long address, ByteBuffer container)

public
DATA_BLOB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static DATA_BLOB
calloc()

Returns a new DATA_BLOB instance allocated with memCalloc.

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

Returns a new DATA_BLOB.Buffer instance allocated with memCalloc.

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

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

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

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

public int
cbData()

the count, in bytes, of data

protected DATA_BLOB
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 DATA_BLOB
create()

Returns a new DATA_BLOB instance allocated with BufferUtils.

public static DATA_BLOB
create(long address)

Returns a new DATA_BLOB instance for the specified memory address.

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

Returns a new DATA_BLOB.Buffer instance allocated with BufferUtils.

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

Create a DATA_BLOB.Buffer instance at the specified memory.

public static DATA_BLOB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static DATA_BLOB
malloc()

Returns a new DATA_BLOB instance allocated with memAlloc.

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

Returns a new DATA_BLOB.Buffer instance allocated with memAlloc.

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

Returns a new DATA_BLOB instance allocated on the specified MemoryStack.

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

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

public static int
ncbData(long struct)

Unsafe version of cbData.

public static void
ncbData(long struct, int value)

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

public static ByteBuffer
npbData(long struct)

Unsafe version of pbData.

public static void
npbData(long struct, ByteBuffer value)

Unsafe version of pbData.

public ByteBuffer
pbData()

a pointer to the data buffer

public DATA_BLOB
pbData(ByteBuffer value)

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

public DATA_BLOB

Returns:

this struct
set
(DATA_BLOB
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.

CBDATAback to summary
public static final int CBDATA

The struct member offsets.

PBDATAback to summary
public static final int PBDATA

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

Constructor Detail

DATA_BLOBback to summary
protected DATA_BLOB(long address, ByteBuffer container)
DATA_BLOBback to summary
public DATA_BLOB(ByteBuffer container)

Creates a DATA_BLOB 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 DATA_BLOB calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static DATA_BLOB calloc(MemoryStack stack)

Returns a new DATA_BLOB 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 DATA_BLOB.Buffer calloc(int capacity, MemoryStack stack)

Returns a new DATA_BLOB.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

cbDataback to summary
public int cbData()

the count, in bytes, of data

Annotations
@NativeType:DWORD
createback to summary
protected DATA_BLOB 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 DATA_BLOB create()

Returns a new DATA_BLOB instance allocated with BufferUtils.

createback to summary
public static DATA_BLOB create(long address)

Returns a new DATA_BLOB instance for the specified memory address.

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

Returns a new DATA_BLOB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a DATA_BLOB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static DATA_BLOB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static DATA_BLOB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static DATA_BLOB malloc(MemoryStack stack)

Returns a new DATA_BLOB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncbDataback to summary
public static int ncbData(long struct)

Unsafe version of cbData.

ncbDataback to summary
public static void ncbData(long struct, int value)

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

npbDataback to summary
public static ByteBuffer npbData(long struct)

Unsafe version of pbData.

npbDataback to summary
public static void npbData(long struct, ByteBuffer value)

Unsafe version of pbData.

pbDataback to summary
public ByteBuffer pbData()

a pointer to the data buffer

Annotations
@NativeType:BYTE *
pbDataback to summary
public DATA_BLOB pbData(ByteBuffer value)

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

setback to summary
public DATA_BLOB set(DATA_BLOB src)

Copies the specified struct data to this struct.

Parameters
src:DATA_BLOB

the source struct

Returns:DATA_BLOB

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.system.windows back to summary

public Class DATA_BLOB.Buffer

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

An array of DATA_BLOB structs.

Field Summary

Modifier and TypeField and Description
private static final DATA_BLOB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new DATA_BLOB.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 int

Returns:

the value of the DATA_BLOB#cbData field.
cbData
()

protected DATA_BLOB
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the DATA_BLOB#pbData field.
pbData
()

public DATA_BLOB.Buffer
pbData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the DATA_BLOB#pbData field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final DATA_BLOB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new DATA_BLOB.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 DATA_BLOB#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

cbDataback to summary
public int cbData()
Returns:int

the value of the DATA_BLOB#cbData field.

Annotations
@NativeType:DWORD
getElementFactoryback to summary
protected DATA_BLOB getElementFactory()

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

Annotations
@Override
pbDataback to summary
public ByteBuffer pbData()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the DATA_BLOB#pbData field.

Annotations
@NativeType:BYTE *
pbDataback to summary
public DATA_BLOB.Buffer pbData(ByteBuffer value)

Sets the address of the specified ByteBuffer to the DATA_BLOB#pbData field.

selfback to summary
protected DATA_BLOB.Buffer self()

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

Annotations
@Override