Class vl::ImagePlane#

a plane of an image, e.g. a separated color channel More...

#include <image.h>

Public Functions#

Type	Name
	ImagePlane ()
	ImagePlane (size_t width, size_t height, PixelFormat format, MemoryResource * memoryResource=defaultHostMemoryResource())
	ImagePlane (size_t width, size_t height, PixelFormat format, uint8_t * data, size_t step=0, MemoryResource * memoryResource=defaultHostMemoryResource())
	ImagePlane (size_t width, size_t height, PixelFormat format, std::shared_ptr< uint8_t[]> data, size_t step=0, MemoryResource * memoryResource=defaultHostMemoryResource())
	ImagePlane (size_t width, size_t height, PixelFormat format, Buffer< uint8_t > buf, size_t step=0)
size_t	bytes () const
ImagePlane	clone (MemoryResource * memoryResource=nullptr) const
void	copyTo (ImagePlane & other) const
void	create (size_t width, size_t height, PixelFormat format, MemoryResource * memoryResource=defaultHostMemoryResource())
uint8_t *	data ()
const uint8_t *	data () const
size_t	height () const
MemoryResource *	memoryResource () const
const PixelFormat &	pixelFormat () const
size_t	step () const
size_t	width () const

Detailed Description#

Gray8 and RGB888 images do have only a single plane!

Public Functions Documentation#

function ImagePlane [1/5]#

vl::ImagePlane::ImagePlane ()

function ImagePlane [2/5]#

vl::ImagePlane::ImagePlane (
    size_t width,
    size_t height,
    PixelFormat format,
    MemoryResource * memoryResource=defaultHostMemoryResource()
)

function ImagePlane [3/5]#

vl::ImagePlane::ImagePlane (
    size_t width,
    size_t height,
    PixelFormat format,
    uint8_t * data,
    size_t step=0,
    MemoryResource * memoryResource=defaultHostMemoryResource()
)

function ImagePlane [4/5]#

vl::ImagePlane::ImagePlane (
    size_t width,
    size_t height,
    PixelFormat format,
    std::shared_ptr< uint8_t []> data,
    size_t step=0,
    MemoryResource * memoryResource=defaultHostMemoryResource()
)

function ImagePlane [5/5]#

vl::ImagePlane::ImagePlane (
    size_t width,
    size_t height,
    PixelFormat format,
    Buffer < uint8_t > buf,
    size_t step=0
)

function bytes#

size_t vl::ImagePlane::bytes () const

function clone#

ImagePlane vl::ImagePlane::clone (
    MemoryResource * memoryResource=nullptr
) const

function copyTo#

void vl::ImagePlane::copyTo (
    ImagePlane & other
) const

function create#

void vl::ImagePlane::create (
    size_t width,
    size_t height,
    PixelFormat format,
    MemoryResource * memoryResource=defaultHostMemoryResource()
)

function data [1/2]#

uint8_t * vl::ImagePlane::data ()

function data [2/2]#

const  uint8_t * vl::ImagePlane::data () const

function height#

size_t vl::ImagePlane::height () const

function memoryResource#

MemoryResource * vl::ImagePlane::memoryResource () const

function pixelFormat#

const  PixelFormat & vl::ImagePlane::pixelFormat () const

function step#

size_t vl::ImagePlane::step () const

function width#

size_t vl::ImagePlane::width () const

The documentation for this class was generated from the following file docs/libvl/build/2.0.0/doxygen/source/vl/image.h