GenDcPart2D Class Reference

Class for a GenDC 2D part descriptor. More...

#include <decl_gendc_descriptor.hpp>

Inherits GenDcPart.

Inherited by GenDcPartH264.

Public Member Functions
virtual std::uint32_t	GetSizeX () const
	Return the X size of the GenDC 2D part.
virtual std::uint32_t	GetSizeY () const
	Return the Y size of the GenDC 2D part.
virtual std::uint16_t	GetPaddingX () const
	Return the X padding of the GenDC 2D part.
virtual std::uint16_t	GetPaddingY () const
	Return the Y padding of the GenDC 2D part.
virtual void	SetSizeX (std::uint32_t size)
	Set the X size of the GenDC 2D part.
virtual void	SetSizeY (std::uint32_t size)
	Set the Y size of the GenDC 2D part.
virtual void	SetPaddingX (std::uint16_t padding)
	Set the X padding of the GenDC 2D part.
virtual void	SetPaddingY (std::uint16_t padding)
	Set the Y padding of the GenDC 2D part.
Public Member Functions inherited from GenDcPart
std::size_t	GetOffset () const
	Return the offset of this part descriptor in the GenDC descriptor.
GenDCPartType	GetType () const
	Return the type of this GenDC part descriptor.
GenDcPartFlags	GetFlags () const
	Return the flags of this GenDC part.
std::uint32_t	GetHeaderSize () const
	Return the size of this GenDC part descriptor.
PfncFormat	GetFormat () const
	Return the data format of this GenDC part.
std::uint16_t	GetFlowId () const
	Return the Flow ID of this GenDC part.
std::size_t	GetFlowOffset () const
	Return the Flow offset of this GenDC part.
std::size_t	GetDataSize () const
	Return the Data size of this GenDC part.
std::size_t	GetDataOffset () const
	Return the Data offset of this GenDC part.
void	SetFlags (GenDcPartFlags flags)
	Set the flags of this GenDC part.
void	SetDataSize (std::size_t size)
	Set the Data size of this GenDC part.
void	SetDataOffset (std::size_t offset)
	Set the Data offset of this GenDC part.

Detailed Description

Class for a GenDC 2D part descriptor.

Member Function Documentation

GetPaddingX()

std::uint16_t GetPaddingX ( ) const

inlinevirtual

Return the X padding of the GenDC 2D part.

Returns

Size of the X padding at the end of each line (in bytes).

Exceptions

Any	exception derived from std::exception including CvbException.

GetPaddingY()

std::uint16_t GetPaddingY ( ) const

inlinevirtual

Return the Y padding of the GenDC 2D part.

Returns

Size of the Y padding at the end of each line (in bytes).

Exceptions

Any	exception derived from std::exception including CvbException.

GetSizeX()

std::uint32_t GetSizeX ( ) const

inlinevirtual

Return the X size of the GenDC 2D part.

Returns

X size of the 2D Part (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

GetSizeY()

std::uint32_t GetSizeY ( ) const

inlinevirtual

Return the Y size of the GenDC 2D part.

Returns

Y size of the 2D Part (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

SetPaddingX()

void SetPaddingX ( std::uint16_t padding )

inlinevirtual

Set the X padding of the GenDC 2D part.

Parameters

[in]

padding

Size of the Y padding at the end of each line (in bytes).

Exceptions

Any	exception derived from std::exception including CvbException.

Note

This method is only supported for user-created GenDC Descriptors.

SetPaddingY()

void SetPaddingY ( std::uint16_t padding )

inlinevirtual

Set the Y padding of the GenDC 2D part.

Parameters

[in]

padding

Size of the Y padding at the end of each line (in bytes).

Exceptions

Any	exception derived from std::exception including CvbException.

Note

This method is only supported for user-created GenDC Descriptors.

SetSizeX()

void SetSizeX ( std::uint32_t size )

inlinevirtual

Set the X size of the GenDC 2D part.

Parameters

[in]

size

X size of the 2D Part (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

Note

This method is only supported for user-created GenDC Descriptors.

SetSizeY()

void SetSizeY ( std::uint32_t size )

inlinevirtual

Set the Y size of the GenDC 2D part.

Parameters

[in]

size

Y size of the 2D Part (in pixels).

Exceptions

Any	exception derived from std::exception including CvbException.

Note

This method is only supported for user-created GenDC Descriptors.