All Classes

All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary
Class	Description
Adapter	Specifies a C++ class to act as an adapter between a target type and one or more adaptee type(s).
AdapterInformation
Allocator	An annotation indicating that a method should behave like an allocator.
ArrayAllocator	An annotation indicating that a method should behave like an array allocator.
AsUtf16	Indicates that `String` should be mapped to array of UTF-16 code units (`unsigned short`) instead of byte array (`const char`).
Attribute
Bfloat16ArrayIndexer	An indexer for a `short[]` array, treated as bfloat16.
Bfloat16BufferIndexer	An indexer for a `ShortBuffer`, treated as bfloat16.
Bfloat16Indexer	Abstract indexer for the `short` primitive type, treated as bfloat16.
Bfloat16RawIndexer	An indexer for a `ShortPointer` using the `Raw` instance, treated as bfloat16.
BooleanArrayIndexer	An indexer for a `boolean[]` array.
BooleanBufferIndexer	An indexer for a `ByteBuffer` as `boolean` values.
BooleanIndexer	Abstract indexer for the `boolean` primitive type.
BooleanPointer	The peer class to native pointers and arrays of `jboolean`.
BooleanRawIndexer	An indexer for a `BooleanPointer` using the `Raw` instance.
BoolPointer	The peer class to native pointers and arrays of `bool`.
BuildEnabled	Classes implementing `InfoMapper` can additionally implement this interface to receive the logger, properties, and encoding associated with the current build session.
Builder	The Builder is responsible for coordinating efforts between the Parser, the Generator, and the native compiler.
BuildMojo	A Maven Mojo to call the `Builder` (C++ header file -> Java class -> C++ JNI -> native library).
ByPtr	Indicates that an argument should get passed or returned by pointer.
ByPtrPtr	Indicates that an argument gets passed or returned by a pointer to a pointer.
ByPtrRef	Indicates that an argument gets passed or returned by a reference to a pointer.
ByRef	Indicates that an argument gets passed or returned by reference.
ByteArrayIndexer	An indexer for a `byte[]` array.
ByteBufferIndexer	An indexer for a `ByteBuffer`.
ByteIndexer	Abstract indexer for the `byte` primitive type.
BytePointer	The peer class to native pointers and arrays of `signed char`, including strings.
ByteRawIndexer	An indexer for a `BytePointer` using the `Raw` instance.
ByVal	Indicates that an argument gets passed or returned by value.
CacheMojo	A Maven Mojo to call the `Loader` on all classes found in the project, as well as call all `cachePackage()` methods found on them.
Cast	Indicates a type cast required on the argument to satisfy the native compiler.
CharArrayIndexer	An indexer for a `char[]` array.
CharBufferIndexer	An indexer for a `CharBuffer`.
CharIndexer	Abstract indexer for the `char` primitive type.
CharPointer	The peer class to native pointers and arrays of `short` for UTF-16.
CharRawIndexer	An indexer for a `CharPointer` using the `Raw` instance.
ClassFilter	An interface used by `ClassScanner` to determine which classes to load.
ClassProperties	Does the heavy lifting of collecting values off Properties annotations found on enclosing classes.
ClassScanner	Given a `UserClassLoader`, attempts to match and fill in a `Collection` of `Class`, in various ways in which users may wish to do so.
ClearMojo	A Maven Mojo to call `Loader.clearCacheDir()`.
CLongPointer	The peer class to native pointers and arrays of `long`.
CommandExecutor	A wrapper for ProcessBuilder that can be overridden easily for frameworks like Gradle that don't support it well.
Const	A shortcut annotation to `Cast` that simply adds `const` to the parameter type, function, or class.
Context
Convention	Specifies the calling convention of a `FunctionPointer`.
CriticalRegion	In some methods, `Generator` will generate code to transfer arrays from the JVM to native code using the `Get/Release<primitivetype>ArrayElements` methods.
Declaration
DeclarationList
Declarator
DocTag	Documentation tags, where we keep only the ones that could be compatible between Javadoc and Doxygen.
DoubleArrayIndexer	An indexer for a `double[]` array.
DoubleBufferIndexer	An indexer for a `DoubleBuffer`.
DoubleIndexer	Abstract indexer for the `double` primitive type.
DoublePointer	The peer class to native pointers and arrays of `double`.
DoubleRawIndexer	An indexer for a `DoublePointer` using the `Raw` instance.
EncodingFileWriter
FloatArrayIndexer	An indexer for a `float[]` array.
FloatBufferIndexer	An indexer for a `FloatBuffer`.
FloatIndexer	Abstract indexer for the `float` primitive type.
FloatPointer	The peer class to native pointers and arrays of `float`.
FloatRawIndexer	An indexer for a `FloatPointer` using the `Raw` instance.
Function	Overrides the detection of allocators, getters, and setters.
FunctionPointer	All peer classes to function pointers must derive from FunctionPointer.
Generator	The Generator is where all the C++ source code that we need gets generated.
Generator.BooleanEnum
Generator.ByteEnum
Generator.IntEnum
Generator.LongEnum
Generator.ShortEnum
HalfArrayIndexer	An indexer for a `short[]` array, treated as half-precision float.
HalfBufferIndexer	An indexer for a `ShortBuffer`, treated as half-precision float.
HalfIndexer	Abstract indexer for the `short` primitive type, treated as half-precision float.
HalfRawIndexer	An indexer for a `ShortPointer` using the `Raw` instance, treated as half-precision float.
HyperslabIndex	A hyperslab is a rectangular pattern defined by four arrays.
Index	Allows using method arguments to call `operator[]` in some circumstances.
Index	Provides an interface for classes that compute a linear index from given array sizes.
Indexable	An interface implemented to let users access data classes via an `Indexer`.
IndexedSet<E>
Indexer	Top-level class of all data indexers, providing easy-to-use and efficient multidimensional access to primitive arrays, NIO buffers, and the raw memory interface.
Info	Holds information useful to the `Parser` and associated with C++ identifiers.
InfoMap	A `Map` containing `Info` objects consumed by the `Parser`.
InfoMapper	An interface to define a kind of configuration file entirely written in Java.
IntArrayIndexer	An indexer for an `int[]` array.
IntBufferIndexer	An indexer for an `IntBuffer`.
IntIndexer	Abstract indexer for the `int` primitive type.
IntPointer	The peer class to native pointers and arrays of `int`, also used for UTF-32.
IntRawIndexer	An indexer for an `IntPointer` using the `Raw` instance.
javacpp
LoadEnabled	Classes implementing this interface can access and modify the `ClassProperties` produced from their `Properties` when `Loader.load(Class)` gets called on them.
Loader	The Loader contains functionality to load native libraries, but also has a bit of everything that does not fit anywhere else.
Loader.Detector
Loader.Helper
Logger	A simple but extensible logging interface that dumps messages to the "standard" output streams by default.
LongArrayIndexer	An indexer for a `long[]` array.
LongBufferIndexer	An indexer for a `LongBuffer`.
LongIndexer	Abstract indexer for the `long` primitive type.
LongPointer	The peer class to native pointers and arrays of `long long`.
LongRawIndexer	An indexer for a `LongPointer` using the `Raw` instance.
MemberGetter	An annotation indicating that a method should behave like a member getter.
MemberSetter	An annotation indicating that a method should behave like a member setter.
MethodInformation
Name	Names the identifier of a native C++ struct, class, union, function, variable, operator, macro, etc.
Namespace	Encloses the scope of a Java class inside the scope of the given C++ namespace.
NoDeallocator	By default, all allocators attach a deallocator to the peer object on creation.
NoException	By default, `Generator` assumes all native functions may throw exceptions.
NoOffset	By default, `Generator` applies `offsetof()` to all member variables.
OneIndex	An Index that supports only one size (a single dimension).
Opaque	This annotation must be used for native types that get declared but not defined.
Optional	A shorthand for `@Adapter("OptionalAdapter<type>")`.
Parameters
ParseMojo	A `BuildMojo` that always forces `BuildMojo.generate` to false, with the goal of parsing header files instead.
Parser	The Parser, just like the Generator, is a mess that is not meant to support the entirety of C++, but an appropriate subset as used by typical C/C++ header files.
ParserException
Platform	Defines native properties for a top-level enclosing class as well as indicates classes and methods that should be generated or not, for specified platforms.
Pointer	All peer classes to native types must be descended from Pointer, the topmost class.
Pointer.CustomDeallocator	A `Pointer.Deallocator` that calls, during garbage collection, a method with signature `static void deallocate()` from the Pointer object passed to the constructor and that accepts it as argument.
Pointer.Deallocator	The interface to implement to produce a Deallocator usable by Pointer.
Pointer.DeallocatorReference	A subclass of `PhantomReference` that also acts as a linked list to keep their references alive until they get garbage collected.
Pointer.DeallocatorThread
Pointer.NativeDeallocator	A `Pointer.Deallocator` that calls, during garbage collection, a native function.
Pointer.ProxyDeallocator	A `Pointer.Deallocator` that keeps and uses a strong reference to a Buffer or another Pointer.
Pointer.ReferenceCounter
PointerBufferPoolMXBean
PointerPointer<P extends Pointer>	The peer class to native pointers and arrays of `void*`.
PointerScope	`Pointer` objects attach themselves automatically on `Pointer.init(long, long, long, long)` to the first `PointerScope` found in `PointerScope.scopeStack` that they can to based on the classes found in `PointerScope.forClasses`.
Properties	Makes it possible to define more than one set of properties for each platform.
Raw	Allows passing and returning Java objects with native functions and raw JNI types.
Raw	The raw memory interface supporting long indexing.
ReverseUnsafeRaw	A raw memory interface based on `UnsafeRaw` that swaps the bytes.
SharedPtr	A shorthand for `@Adapter("SharedPtrAdapter<type>")`.
ShortArrayIndexer	An indexer for a `short[]` array.
ShortBufferIndexer	An indexer for a `ShortBuffer`.
ShortIndexer	Abstract indexer for the `short` primitive type.
ShortPointer	The peer class to native pointers and arrays of `short`.
ShortRawIndexer	An indexer for a `ShortPointer` using the `Raw` instance.
SizeTPointer	The peer class to native pointers and arrays of `size_t`.
Slf4jLogger	A logger that delegates messages to SLF4J.
StdBasicString
StdMove	A shorthand for `@Adapter("MoveAdapter<type>")`.
StdString	A shorthand for `@Cast("std::string&") @Adapter("StringAdapter<char>")`.
StdU16String
StdU32String
StdVector	A shorthand for `@Adapter("VectorAdapter<type>")`.
StdWString	A shorthand for `@Cast("std::wstring&") @Adapter("StringAdapter<wchar_t>")`.
StrideIndex	An Index that computes a linear index from given array sizes and strides.
TemplateMap
Templates
Token
TokenIndexer
Tokenizer
Type
UByteArrayIndexer	An indexer for a `byte[]` array, treated as unsigned.
UByteBufferIndexer	An indexer for a `ByteBuffer`, treated as unsigned.
UByteIndexer	Abstract indexer for the `byte` primitive type, treated as unsigned.
UByteRawIndexer	An indexer for a `BytePointer` using the `Raw` instance, treated as unsigned.
UIntArrayIndexer	An indexer for a `int[]` array, treated as unsigned.
UIntBufferIndexer	An indexer for a `IntBuffer`, treated as unsigned.
UIntIndexer	Abstract indexer for the `int` primitive type, treated as unsigned.
UIntRawIndexer	An indexer for a `IntPointer` using the `Raw` instance, treated as unsigned.
ULongArrayIndexer	An indexer for a `long[]` array, treated as unsigned.
ULongBufferIndexer	An indexer for a `LongBuffer`, treated as unsigned.
ULongIndexer	Abstract indexer for the `long` primitive type, treated as unsigned.
ULongRawIndexer	An indexer for a `LongPointer` using the `Raw` instance, treated as unsigned.
UniquePtr	A shorthand for `@Adapter("UniquePtrAdapter<type>")`.
UnsafeRaw	The raw memory interface based on `Unsafe`.
UserClassLoader	An extension of `URLClassLoader` that keeps a list of paths in memory.
UShortArrayIndexer	An indexer for a `short[]` array, treated as unsigned.
UShortBufferIndexer	An indexer for a `ShortBuffer`, treated as unsigned.
UShortIndexer	Abstract indexer for the `short` primitive type, treated as unsigned.
UShortRawIndexer	An indexer for a `ShortPointer` using the `Raw` instance, treated as unsigned.
ValueGetter	An annotation indicating that a method should behave like a value getter.
ValueSetter	An annotation indicating that a method should behave like a value setter.
Virtual	Indicates that a method maps to a virtual function in C++.