Class mediapipe::ImageFrame

ClassList > mediapipe > ImageFrame

Classes

Type	Name
class	PixelDataDeleter

Public Types

Type	Name
typedef std::function< void(uint8_t *)>	Deleter

Public Static Attributes

Type	Name
const uint32_t	kDefaultAlignmentBoundary = 16
const uint32_t	kGlDefaultAlignmentBoundary = 4

Public Functions

Type	Name
void	AdoptPixelData (ImageFormat::Format format, int width, int height, int width_step, uint8_t * pixel_data, Deleter deleter=std::default_delete< uint8_t[]>())
int	ByteDepth () const
int	ChannelSize () const
void	CopyFrom (const ImageFrame & image_frame, uint32_t alignment_boundary)
void	CopyPixelData (ImageFormat::Format format, int width, int height, const uint8_t * pixel_data, uint32_t alignment_boundary)
void	CopyPixelData (ImageFormat::Format format, int width, int height, int width_step, const uint8_t * pixel_data, uint32_t alignment_boundary)
void	CopyToBuffer (uint8_t * buffer, int buffer_size) const
void	CopyToBuffer (uint16_t * buffer, int buffer_size) const
void	CopyToBuffer (float * buffer, int buffer_size) const
ImageFormat::Format	Format () const
int	Height () const
	ImageFrame (const ImageFrame &) = delete
	ImageFrame ()
	ImageFrame (ImageFormat::Format format, int width, int height, uint32_t alignment_boundary)
	ImageFrame (ImageFormat::Format format, int width, int height)
	ImageFrame (ImageFormat::Format format, int width, int height, int width_step, uint8_t * pixel_data, Deleter deleter=std::default_delete< uint8_t[]>())
	ImageFrame (ImageFrame && move_from)
bool	IsAligned (uint32_t alignment_boundary) const
bool	IsContiguous () const
bool	IsEmpty () const
uint8_t *	MutablePixelData ()
int	NumberOfChannels () const
const uint8_t *	PixelData () const
int	PixelDataSize () const
int	PixelDataSizeStoredContiguously () const
std::unique_ptr< uint8_t[], Deleter >	Release ()
void	Reset (ImageFormat::Format format, int width, int height, uint32_t alignment_boundary)
void	SetAlignmentPaddingAreas ()
void	SetToZero ()
int	Width () const
int	WidthStep () const
ImageFrame &	operator= (const ImageFrame &) = delete
ImageFrame &	operator= (ImageFrame && move_from)

Public Static Functions

Type	Name
int	ByteDepthForFormat (ImageFormat::Format format)
int	ChannelSizeForFormat (ImageFormat::Format format)
std::string	InvalidFormatString (ImageFormat::Format format)
int	NumberOfChannelsForFormat (ImageFormat::Format format)

Public Types Documentation

typedef Deleter

typedef std::function<void(uint8_t*)> mediapipe::ImageFrame::Deleter;

---

Public Static Attributes Documentation

variable kDefaultAlignmentBoundary

const uint32_t mediapipe::ImageFrame::kDefaultAlignmentBoundary;

---

variable kGlDefaultAlignmentBoundary

const uint32_t mediapipe::ImageFrame::kGlDefaultAlignmentBoundary;

---

Public Functions Documentation

function AdoptPixelData

void mediapipe::ImageFrame::AdoptPixelData (
    ImageFormat::Format format,
    int width,
    int height,
    int width_step,
    uint8_t * pixel_data,
    Deleter deleter=std::default_delete< uint8_t[]>()
) 

---

function ByteDepth

int mediapipe::ImageFrame::ByteDepth () const

---

function ChannelSize

int mediapipe::ImageFrame::ChannelSize () const

---

function CopyFrom

void mediapipe::ImageFrame::CopyFrom (
    const ImageFrame & image_frame,
    uint32_t alignment_boundary
) 

---

function CopyPixelData [1/2]

void mediapipe::ImageFrame::CopyPixelData (
    ImageFormat::Format format,
    int width,
    int height,
    const uint8_t * pixel_data,
    uint32_t alignment_boundary
) 

---

function CopyPixelData [2/2]

void mediapipe::ImageFrame::CopyPixelData (
    ImageFormat::Format format,
    int width,
    int height,
    int width_step,
    const uint8_t * pixel_data,
    uint32_t alignment_boundary
) 

---

function CopyToBuffer [1/3]

void mediapipe::ImageFrame::CopyToBuffer (
    uint8_t * buffer,
    int buffer_size
) const

---

function CopyToBuffer [2/3]

void mediapipe::ImageFrame::CopyToBuffer (
    uint16_t * buffer,
    int buffer_size
) const

---

function CopyToBuffer [3/3]

void mediapipe::ImageFrame::CopyToBuffer (
    float * buffer,
    int buffer_size
) const

---

function Format

inline ImageFormat::Format mediapipe::ImageFrame::Format () const

---

function Height

inline int mediapipe::ImageFrame::Height () const

---

function ImageFrame [1/6]

mediapipe::ImageFrame::ImageFrame (
    const ImageFrame &
) = delete

---

function ImageFrame [2/6]

mediapipe::ImageFrame::ImageFrame () 

---

function ImageFrame [3/6]

mediapipe::ImageFrame::ImageFrame (
    ImageFormat::Format format,
    int width,
    int height,
    uint32_t alignment_boundary
) 

---

function ImageFrame [4/6]

mediapipe::ImageFrame::ImageFrame (
    ImageFormat::Format format,
    int width,
    int height
) 

---

function ImageFrame [5/6]

mediapipe::ImageFrame::ImageFrame (
    ImageFormat::Format format,
    int width,
    int height,
    int width_step,
    uint8_t * pixel_data,
    Deleter deleter=std::default_delete< uint8_t[]>()
) 

---

function ImageFrame [6/6]

mediapipe::ImageFrame::ImageFrame (
    ImageFrame && move_from
) 

---

function IsAligned

bool mediapipe::ImageFrame::IsAligned (
    uint32_t alignment_boundary
) const

---

function IsContiguous

bool mediapipe::ImageFrame::IsContiguous () const

---

function IsEmpty

inline bool mediapipe::ImageFrame::IsEmpty () const

---

function MutablePixelData

inline uint8_t * mediapipe::ImageFrame::MutablePixelData () 

---

function NumberOfChannels

int mediapipe::ImageFrame::NumberOfChannels () const

---

function PixelData

inline const uint8_t * mediapipe::ImageFrame::PixelData () const

---

function PixelDataSize

inline int mediapipe::ImageFrame::PixelDataSize () const

---

function PixelDataSizeStoredContiguously

inline int mediapipe::ImageFrame::PixelDataSizeStoredContiguously () const

---

function Release

std::unique_ptr< uint8_t[], Deleter > mediapipe::ImageFrame::Release () 

---

function Reset

void mediapipe::ImageFrame::Reset (
    ImageFormat::Format format,
    int width,
    int height,
    uint32_t alignment_boundary
) 

---

function SetAlignmentPaddingAreas

void mediapipe::ImageFrame::SetAlignmentPaddingAreas () 

---

function SetToZero

void mediapipe::ImageFrame::SetToZero () 

---

function Width

inline int mediapipe::ImageFrame::Width () const

---

function WidthStep

inline int mediapipe::ImageFrame::WidthStep () const

---

function operator=

ImageFrame & mediapipe::ImageFrame::operator= (
    const ImageFrame &
) = delete

---

function operator=

ImageFrame & mediapipe::ImageFrame::operator= (
    ImageFrame && move_from
) 

---

Public Static Functions Documentation

function ByteDepthForFormat

static int mediapipe::ImageFrame::ByteDepthForFormat (
    ImageFormat::Format format
) 

---

function ChannelSizeForFormat

static int mediapipe::ImageFrame::ChannelSizeForFormat (
    ImageFormat::Format format
) 

---

function InvalidFormatString

static std::string mediapipe::ImageFrame::InvalidFormatString (
    ImageFormat::Format format
) 

---

function NumberOfChannelsForFormat

static int mediapipe::ImageFrame::NumberOfChannelsForFormat (
    ImageFormat::Format format
) 

---

---

The documentation for this class was generated from the following file /home/friedel/devel/ILLIXR-plugins/hand_tracking/mediapipe/framework/formats/image_frame.h