CXIdxEntityRefInfo (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

org.lwjgl.system.Pointer
```
public class CXIdxEntityRefInfo
extends org.lwjgl.system.Struct
```
Data for IndexerCallbacks.indexEntityReference().
Member documentation
- cursor – reference cursor
- referencedEntity – the entity that gets referenced
- parentEntity – Immediate "parent" of the reference. For example:
```
 Foo *var;
```
  The parent of reference of type Foo is the variable var. For references inside statement bodies of functions/methods, the parentEntity will be the function/method.
- container – lexical container context of the reference
- role – sets of symbol roles of the reference
Layout
```
 struct CXIdxEntityRefInfo {
     CXIdxEntityRefKind kind;
     CXCursor cursor;
     CXIdxLoc loc;
     CXIdxEntityInfo const * referencedEntity;
     CXIdxEntityInfo const * parentEntity;
     CXIdxContainerInfo const * container;
     CXSymbolRole role;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CXIdxEntityRefInfo.Buffer
An array of CXIdxEntityRefInfo 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`	`CXIdxEntityRefInfo.Buffer` An array of `CXIdxEntityRefInfo` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`CONTAINER` The struct member offsets.
`static int`	`CURSOR` The struct member offsets.
`static int`	`KIND` The struct member offsets.
`static int`	`LOC` The struct member offsets.
`static int`	`PARENTENTITY` The struct member offsets.
`static int`	`REFERENCEDENTITY` The struct member offsets.
`static int`	`ROLE` 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
`CXIdxEntityRefInfo(java.nio.ByteBuffer container)` Creates a `CXIdxEntityRefInfo` 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
`CXIdxContainerInfo`	`container()` Returns a `CXIdxContainerInfo` view of the struct pointed to by the `container` field.
`static CXIdxEntityRefInfo`	`create(long address)` Returns a new `CXIdxEntityRefInfo` instance for the specified memory address.
`static CXIdxEntityRefInfo.Buffer`	`create(long address, int capacity)` Create a `CXIdxEntityRefInfo.Buffer` instance at the specified memory.
`static CXIdxEntityRefInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static CXIdxEntityRefInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`CXCursor`	`cursor()` Returns a `CXCursor` view of the `cursor` field.
`int`	`kind()` Returns the value of the `kind` field.
`CXIdxLoc`	`loc()` Returns a `CXIdxLoc` view of the `loc` field.
`static CXIdxContainerInfo`	`ncontainer(long struct)` Unsafe version of `container()`.
`static CXCursor`	`ncursor(long struct)` Unsafe version of `cursor()`.
`static int`	`nkind(long struct)` Unsafe version of `kind()`.
`static CXIdxLoc`	`nloc(long struct)` Unsafe version of `loc()`.
`static CXIdxEntityInfo`	`nparentEntity(long struct)` Unsafe version of `parentEntity()`.
`static CXIdxEntityInfo`	`nreferencedEntity(long struct)` Unsafe version of `referencedEntity()`.
`static int`	`nrole(long struct)` Unsafe version of `role()`.
`CXIdxEntityInfo`	`parentEntity()` Returns a `CXIdxEntityInfo` view of the struct pointed to by the `parentEntity` field.
`CXIdxEntityInfo`	`referencedEntity()` Returns a `CXIdxEntityInfo` view of the struct pointed to by the `referencedEntity` field.
`int`	`role()` Returns the value of the `role` field.
`int`	`sizeof()`

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - KIND
```
public static final int KIND
```
    The struct member offsets.
  - CURSOR
```
public static final int CURSOR
```
    The struct member offsets.
  - LOC
```
public static final int LOC
```
    The struct member offsets.
  - REFERENCEDENTITY
```
public static final int REFERENCEDENTITY
```
    The struct member offsets.
  - PARENTENTITY
```
public static final int PARENTENTITY
```
    The struct member offsets.
  - CONTAINER
```
public static final int CONTAINER
```
    The struct member offsets.
  - ROLE
```
public static final int ROLE
```
    The struct member offsets.
- Constructor Detail
  - CXIdxEntityRefInfo
```
public CXIdxEntityRefInfo(java.nio.ByteBuffer container)
```
    Creates a CXIdxEntityRefInfo 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
  - kind
```
public int kind()
```
    Returns the value of the kind field.
  - cursor
```
public CXCursor cursor()
```
    Returns a CXCursor view of the cursor field.
  - loc
```
public CXIdxLoc loc()
```
    Returns a CXIdxLoc view of the loc field.
  - referencedEntity
```
public CXIdxEntityInfo referencedEntity()
```
    Returns a CXIdxEntityInfo view of the struct pointed to by the referencedEntity field.
  - parentEntity
```
public CXIdxEntityInfo parentEntity()
```
    Returns a CXIdxEntityInfo view of the struct pointed to by the parentEntity field.
  - container
```
public CXIdxContainerInfo container()
```
    Returns a CXIdxContainerInfo view of the struct pointed to by the container field.
  - role
```
public int role()
```
    Returns the value of the role field.
  - create
```
public static CXIdxEntityRefInfo create(long address)
```
    Returns a new CXIdxEntityRefInfo instance for the specified memory address.
  - createSafe
```
@Nullable
public static CXIdxEntityRefInfo createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - create
```
public static CXIdxEntityRefInfo.Buffer create(long address,
                                               int capacity)
```
    Create a CXIdxEntityRefInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static CXIdxEntityRefInfo.Buffer createSafe(long address,
                                                             int capacity)
```
    Like create, but returns null if address is NULL.
  - nkind
```
public static int nkind(long struct)
```
    Unsafe version of kind().
  - ncursor
```
public static CXCursor ncursor(long struct)
```
    Unsafe version of cursor().
  - nloc
```
public static CXIdxLoc nloc(long struct)
```
    Unsafe version of loc().
  - nreferencedEntity
```
public static CXIdxEntityInfo nreferencedEntity(long struct)
```
    Unsafe version of referencedEntity().
  - nparentEntity
```
public static CXIdxEntityInfo nparentEntity(long struct)
```
    Unsafe version of parentEntity().
  - ncontainer
```
public static CXIdxContainerInfo ncontainer(long struct)
```
    Unsafe version of container().
  - nrole
```
public static int nrole(long struct)
```
    Unsafe version of role().

Class CXIdxEntityRefInfo

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

Field Detail

SIZEOF

ALIGNOF

KIND

CURSOR

LOC

REFERENCEDENTITY

PARENTENTITY

CONTAINER

ROLE

Constructor Detail

CXIdxEntityRefInfo

Method Detail

sizeof

kind

cursor

loc

referencedEntity

parentEntity

container

role

create

createSafe

create

createSafe

nkind

ncursor

nloc

nreferencedEntity

nparentEntity

ncontainer

nrole