VideoFrame::FrameBufferKey Class Reference

Collaboration diagram for VideoFrame::FrameBufferKey:

Public Member Functions
	FrameBufferKey (const int width, const int height, const int pixFmt, const bool lineAligned)
	Constructs a new FrameBufferKey with the given attributes. More...
	FrameBufferKey (const FrameBufferKey &)=default
	FrameBufferKey (FrameBufferKey &&)=default
	~FrameBufferKey ()=default
const FrameBufferKey &	operator= (const FrameBufferKey &)=delete
const FrameBufferKey &	operator= (FrameBufferKey &&)=delete
bool	operator== (const FrameBufferKey &other) const
	Comparison operator for FrameBufferKey. More...
bool	operator!= (const FrameBufferKey &other) const
	Not equal to operator for FrameBufferKey. More...

Static Public Member Functions
static size_t	hash (const FrameBufferKey &key)
	Hash function for FrameBufferKey. More...

Public Attributes
const int	frameWidth
const int	frameHeight
const int	pixelFormat
const bool	linesizeAligned

Detailed Description

Definition at line 97 of file videoframe.h.

Constructor & Destructor Documentation

FrameBufferKey() [1/3]

VideoFrame::FrameBufferKey::FrameBufferKey	(	const int	width,
		const int	height,
		const int	pixFmt,
		const bool	lineAligned
	)

Constructs a new FrameBufferKey with the given attributes.

Parameters

width	the width of the frame.
height	the height of the frame.
pixFmt	the pixel format of the frame.
lineAligned	whether the linesize matches the width of the image.

Definition at line 422 of file videoframe.cpp.

FrameBufferKey() [2/3]

VideoFrame::FrameBufferKey::FrameBufferKey ( const FrameBufferKey &  )

default

FrameBufferKey() [3/3]

VideoFrame::FrameBufferKey::FrameBufferKey ( FrameBufferKey &&  )

default

~FrameBufferKey()

VideoFrame::FrameBufferKey::~FrameBufferKey ( )

default

Member Function Documentation

hash()

size_t VideoFrame::FrameBufferKey::hash ( const FrameBufferKey &  key )

static

Hash function for FrameBufferKey.

This function computes a hash value for use with std::unordered_map.

Parameters

key	the given instance to compute hash value of.

Returns

the hash of the given instance.

Definition at line 462 of file videoframe.cpp.

operator!=()

bool VideoFrame::FrameBufferKey::operator!=

(

const FrameBufferKey &

other

)

const

Not equal to operator for FrameBufferKey.

Parameters

other

instance to compare against

Returns

true if instances are not equivilent, false otherwise.

Definition at line 449 of file videoframe.cpp.

operator=() [1/2]

const FrameBufferKey& VideoFrame::FrameBufferKey::operator= ( const FrameBufferKey &  )

delete

operator=() [2/2]

const FrameBufferKey& VideoFrame::FrameBufferKey::operator= ( FrameBufferKey &&  )

delete

operator==()

bool VideoFrame::FrameBufferKey::operator==

(

const FrameBufferKey &

other

)

const

Comparison operator for FrameBufferKey.

Parameters

other

instance to compare against.

Returns

true if instances are equivilent, false otherwise.

Definition at line 437 of file videoframe.cpp.

Member Data Documentation

frameHeight

const int VideoFrame::FrameBufferKey::frameHeight

Definition at line 120 of file videoframe.h.

frameWidth

const int VideoFrame::FrameBufferKey::frameWidth

Definition at line 119 of file videoframe.h.

linesizeAligned

const bool VideoFrame::FrameBufferKey::linesizeAligned

Definition at line 122 of file videoframe.h.

pixelFormat

const int VideoFrame::FrameBufferKey::pixelFormat

Definition at line 121 of file videoframe.h.

---

The documentation for this class was generated from the following files:

• src/video/videoframe.h
• src/video/videoframe.cpp