org.bytedeco.opencv.opencv_core

Class HostMem

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_core.HostMem

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::cuda")
 @NoOffset
 @Properties(inherit=opencv_core.class)
public class HostMem
extends Pointer

\brief Class with reference counting wrapping special memory type allocation functions from CUDA.

Its interface is also Mat-like but with additional memory type parameters.

- **PAGE_LOCKED** sets a page locked memory type used commonly for fast and asynchronous uploading/downloading data from/to GPU. - **SHARED** specifies a zero copy memory allocation that enables mapping the host memory to GPU address space, if supported. - **WRITE_COMBINED** sets the write combined buffer that is not cached by CPU. Such buffers are used to supply GPU with data when GPU only reads it. The advantage is a better CPU cache utilization.

\note Allocation size of such memory types is usually limited. For more details, see *CUDA 2.2 Pinned Memory APIs* document or *CUDA C Programming Guide*.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_LOCKED enum cv::cuda::HostMem::AllocType
static int	SHARED enum cv::cuda::HostMem::AllocType
static int	WRITE_COMBINED enum cv::cuda::HostMem::AllocType

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
HostMem()
HostMem(GpuMat arr)
HostMem(GpuMat arr, int alloc_type)
HostMem(HostMem m)
HostMem(int alloc_type)
HostMem(int rows, int cols, int type)
HostMem(int rows, int cols, int type, int alloc_type)
HostMem(Mat arr)
HostMem(Mat arr, int alloc_type) creates from host memory with coping data
HostMem(Pointer p) Pointer cast constructor.
HostMem(Size size, int type)
HostMem(Size size, int type, int alloc_type)
HostMem(UMat arr)
HostMem(UMat arr, int alloc_type)

Method Summary

Modifier and Type	Method and Description
int	alloc_type()
HostMem	alloc_type(int setter)
int	channels()
HostMem	clone() returns deep copy of the matrix, i.e.
int	cols()
HostMem	cols(int setter)
void	create(int rows, int cols, int type) allocates new matrix data unless the matrix already has specified size and type.
void	create(Size size, int type)
GpuMat	createGpuMatHeader() \brief Maps CPU memory to GPU address space and creates the cuda::GpuMat header without reference counting for it.
Mat	createMatHeader() returns matrix header with disabled reference counting for HostMem data.
BytePointer	data()
HostMem	data(BytePointer setter)
BytePointer	dataend()
HostMem	dataend(BytePointer setter)
BytePointer	datastart()
HostMem	datastart(BytePointer setter)
int	depth()
long	elemSize()
long	elemSize1()
boolean	empty()
int	flags()
HostMem	flags(int setter)
static MatAllocator	getAllocator()
static MatAllocator	getAllocator(int alloc_type)
boolean	isContinuous()
HostMem	put(HostMem m)
IntPointer	refcount()
HostMem	refcount(IntPointer setter)
void	release() decrements reference counter and released memory if needed.
HostMem	reshape(int cn)
HostMem	reshape(int cn, int rows) creates alternative HostMem header for the same data, with different number of channels and/or different number of rows
int	rows()
HostMem	rows(int setter)
Size	size()
long	step()
HostMem	step(long setter)
long	step1()
void	swap(HostMem b) swaps with other smart pointer
int	type()

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PAGE_LOCKED

public static final int PAGE_LOCKED

enum cv::cuda::HostMem::AllocType

See Also:

Constant Field Values

SHARED

public static final int SHARED

enum cv::cuda::HostMem::AllocType

See Also:

Constant Field Values

WRITE_COMBINED

public static final int WRITE_COMBINED

enum cv::cuda::HostMem::AllocType

See Also:

Constant Field Values

Constructor Detail

HostMem

public HostMem(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

HostMem

public HostMem(@Cast(value="cv::cuda::HostMem::AllocType")
               int alloc_type)

HostMem

public HostMem()

HostMem

public HostMem(@Const @ByRef
               HostMem m)

HostMem

public HostMem(int rows,
               int cols,
               int type,
               @Cast(value="cv::cuda::HostMem::AllocType")
               int alloc_type)

HostMem

public HostMem(int rows,
               int cols,
               int type)

HostMem

public HostMem(@ByVal
               Size size,
               int type,
               @Cast(value="cv::cuda::HostMem::AllocType")
               int alloc_type)

HostMem

public HostMem(@ByVal
               Size size,
               int type)

HostMem

public HostMem(@ByVal
               Mat arr,
               @Cast(value="cv::cuda::HostMem::AllocType")
               int alloc_type)

creates from host memory with coping data

HostMem

public HostMem(@ByVal
               Mat arr)

HostMem

public HostMem(@ByVal
               UMat arr,
               @Cast(value="cv::cuda::HostMem::AllocType")
               int alloc_type)

HostMem

public HostMem(@ByVal
               UMat arr)

HostMem

public HostMem(@ByVal
               GpuMat arr,
               @Cast(value="cv::cuda::HostMem::AllocType")
               int alloc_type)

HostMem

public HostMem(@ByVal
               GpuMat arr)

Method Detail

getAllocator

public static MatAllocator getAllocator(@Cast(value="cv::cuda::HostMem::AllocType")
                                        int alloc_type)

getAllocator

public static MatAllocator getAllocator()

put

@ByRef
 @Name(value="operator =")
public HostMem put(@Const @ByRef
                                                     HostMem m)

swap

public void swap(@ByRef
                 HostMem b)

swaps with other smart pointer

clone

@ByVal
public HostMem clone()

returns deep copy of the matrix, i.e. the data is copied

Overrides:

clone in class Object

create

public void create(int rows,
                   int cols,
                   int type)

allocates new matrix data unless the matrix already has specified size and type.

create

public void create(@ByVal
                   Size size,
                   int type)

reshape

@ByVal
public HostMem reshape(int cn,
                              int rows)

creates alternative HostMem header for the same data, with different number of channels and/or different number of rows

reshape

@ByVal
public HostMem reshape(int cn)

release

public void release()

decrements reference counter and released memory if needed.

createMatHeader

@ByVal
public Mat createMatHeader()

returns matrix header with disabled reference counting for HostMem data.

createGpuMatHeader

@ByVal
public GpuMat createGpuMatHeader()

\brief Maps CPU memory to GPU address space and creates the cuda::GpuMat header without reference counting for it.

This can be done only if memory was allocated with the SHARED flag and if it is supported by the hardware. Laptops often share video and CPU memory, so address spaces can be mapped, which eliminates an extra copy.

isContinuous

@Cast(value="bool")
public boolean isContinuous()

elemSize

@Cast(value="size_t")
public long elemSize()

elemSize1

@Cast(value="size_t")
public long elemSize1()

type

public int type()

depth

public int depth()

channels

public int channels()

step1

@Cast(value="size_t")
public long step1()

size

@ByVal
public Size size()

empty

@Cast(value="bool")
public boolean empty()

flags

public int flags()

flags

public HostMem flags(int setter)

rows

public int rows()

rows

public HostMem rows(int setter)

cols

public int cols()

cols

public HostMem cols(int setter)

step

@Cast(value="size_t")
public long step()

step

public HostMem step(long setter)

data

@Cast(value="uchar*")
public BytePointer data()

data

public HostMem data(BytePointer setter)

refcount

public IntPointer refcount()

refcount

public HostMem refcount(IntPointer setter)

datastart

@Cast(value="uchar*")
public BytePointer datastart()

datastart

public HostMem datastart(BytePointer setter)

dataend

@Cast(value="const uchar*")
public BytePointer dataend()

dataend

public HostMem dataend(BytePointer setter)

alloc_type

@Cast(value="cv::cuda::HostMem::AllocType")
public int alloc_type()

alloc_type

public HostMem alloc_type(int setter)