AJA NTV2 SDK  17.6.0.2675
NTV2 SDK 17.6.0.2675
Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | List of all members
NTV2FrameSize Class Reference

Describes the horizontal and vertical size dimensions of a raster, bitmap, frame or image. More...

#include <ntv2publicinterface.h>

Public Member Functions

 NTV2FrameSize (const ULWord inWidth=0, const ULWord inHeight=0)
 My constructor. More...
 
 NTV2FrameSize (const NTV2FrameGeometry inFG)
 
 operator NTV2FrameGeometry () const
 
NTV2FrameSize & setWidth (const ULWord inValue)
 Sets my width dimension. More...
 
NTV2FrameSize & setHeight (const ULWord inValue)
 Sets my height dimension. More...
 
NTV2FrameSize & set (const ULWord inWidth, const ULWord inHeight)
 Sets my dimension values. More...
 
NTV2FrameSize & operator= (const NTV2FrameGeometry &rhs)
 Assigns me from an NTV2FrameGeometry. More...
 
NTV2FrameSize & reset (void)
 Sets both my width and height to zero (an invalid state). More...
 
NTV2FrameSize & swap (void)
 Swaps my width and height. More...
 

Static Public Member Functions

static ULWord FGWidth (const NTV2FrameGeometry fg)
 
static ULWord FGHeight (const NTV2FrameGeometry fg)
 

Protected Types

typedef std::map< NTV2FrameGeometry, ULWord > FGSizesMap
 
typedef FGSizesMap::const_iterator FGSizesMapCI
 

Protected Member Functions

uint64_t magnitude (void) const
 

Detailed Description

Describes the horizontal and vertical size dimensions of a raster, bitmap, frame or image.

Note
Renamed in SDK 17.5 from NTV2FrameDimensions to NTV2FrameSize.

Definition at line 5812 of file ntv2publicinterface.h.

Member Typedef Documentation

◆ FGSizesMap

typedef std::map<NTV2FrameGeometry, ULWord> NTV2FrameSize::FGSizesMap
protected

Definition at line 5889 of file ntv2publicinterface.h.

◆ FGSizesMapCI

typedef FGSizesMap::const_iterator NTV2FrameSize::FGSizesMapCI
protected

Definition at line 5890 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2FrameSize() [1/2]

NTV2FrameSize::NTV2FrameSize ( const ULWord  inWidth = 0,
const ULWord  inHeight = 0 
)
inlineexplicit

My constructor.

Parameters
[in]inWidthOptionally specifies my initial width dimension, in pixels. Defaults to zero.
[in]inHeightOptionally specifies my initial height dimension, in lines. Defaults to zero.

Definition at line 5821 of file ntv2publicinterface.h.

◆ NTV2FrameSize() [2/2]

NTV2FrameSize::NTV2FrameSize ( const NTV2FrameGeometry  inFG)
inlineexplicit

Definition at line 5822 of file ntv2publicinterface.h.

Member Function Documentation

◆ FGHeight()

ULWord NTV2FrameSize::FGHeight ( const NTV2FrameGeometry  fg)
static

Definition at line 1523 of file ntv2publicinterface.cpp.

◆ FGWidth()

ULWord NTV2FrameSize::FGWidth ( const NTV2FrameGeometry  fg)
static

Definition at line 1497 of file ntv2publicinterface.cpp.

◆ magnitude()

uint64_t NTV2FrameSize::magnitude ( void  ) const
inlineprotected

Definition at line 5888 of file ntv2publicinterface.h.

◆ operator NTV2FrameGeometry()

NTV2FrameSize::operator NTV2FrameGeometry ( ) const
Returns
my NTV2FrameGeometry or NTV2_FG_INVALID if invalid or non-SMPTE

Definition at line 1492 of file ntv2publicinterface.cpp.

◆ operator=()

NTV2FrameSize& NTV2FrameSize::operator= ( const NTV2FrameGeometry &  rhs)
inline

Assigns me from an NTV2FrameGeometry.

Parameters
[in]rhsSpecifies the NTV2FrameGeometry.
Returns
A non-constant reference to me.

Definition at line 5858 of file ntv2publicinterface.h.

◆ reset()

NTV2FrameSize& NTV2FrameSize::reset ( void  )
inline

Sets both my width and height to zero (an invalid state).

Returns
A non-constant reference to me.

Definition at line 5864 of file ntv2publicinterface.h.

◆ set()

NTV2FrameSize& NTV2FrameSize::set ( const ULWord  inWidth,
const ULWord  inHeight 
)
inline

Sets my dimension values.

Parameters
[in]inWidthSpecifies the new width dimension, in pixels.
[in]inHeightSpecifies the new height dimension, in lines.
Returns
A non-constant reference to me.

Definition at line 5851 of file ntv2publicinterface.h.

◆ setHeight()

NTV2FrameSize& NTV2FrameSize::setHeight ( const ULWord  inValue)
inline

Sets my height dimension.

Parameters
[in]inValueSpecifies the new height dimension, in lines.
Returns
A non-constant reference to me.

Definition at line 5843 of file ntv2publicinterface.h.

◆ setWidth()

NTV2FrameSize& NTV2FrameSize::setWidth ( const ULWord  inValue)
inline

Sets my width dimension.

Parameters
[in]inValueSpecifies the new width dimension, in pixels.
Returns
A non-constant reference to me.

Definition at line 5836 of file ntv2publicinterface.h.

◆ swap()

NTV2FrameSize& NTV2FrameSize::swap ( void  )
inline

Swaps my width and height.

Returns
A non-constant reference to me.

Definition at line 5870 of file ntv2publicinterface.h.

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