NTV2FrameDimensions Class Reference

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

#include <ntv2publicinterface.h>

Public Member Functions
	NTV2FrameDimensions (const ULWord inWidth=0, const ULWord inHeight=0)
	My constructor. More...
NTV2FrameDimensions &	SetWidth (const ULWord inValue)
	Sets my width dimension. More...
NTV2FrameDimensions &	SetHeight (const ULWord inValue)
	Sets my height dimension. More...
NTV2FrameDimensions &	Set (const ULWord inWidth, const ULWord inHeight)
	Sets my dimension values. More...
NTV2FrameDimensions &	Reset (void)
	Sets both my width and height to zero (an invalid state). More...

Detailed Description

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

Definition at line 5658 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

NTV2FrameDimensions()

NTV2FrameDimensions::NTV2FrameDimensions ( const ULWord  inWidth = 0, const ULWord  inHeight = 0  )

inline

My constructor.

Parameters

[in]	inWidth	Optionally specifies my initial width dimension, in pixels. Defaults to zero.
[in]	inHeight	Optionally specifies my initial height dimension, in lines. Defaults to zero.

Definition at line 5667 of file ntv2publicinterface.h.

Member Function Documentation

Reset()

NTV2FrameDimensions& NTV2FrameDimensions::Reset ( void  )

inline

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

Returns

A non-constant reference to me.

Definition at line 5700 of file ntv2publicinterface.h.

Set()

NTV2FrameDimensions& NTV2FrameDimensions::Set ( const ULWord  inWidth, const ULWord  inHeight  )

inline

Sets my dimension values.

Parameters

[in]	inWidth	Specifies the new width dimension, in pixels.
[in]	inHeight	Specifies the new height dimension, in lines.

Returns

A non-constant reference to me.

Definition at line 5694 of file ntv2publicinterface.h.

SetHeight()

NTV2FrameDimensions& NTV2FrameDimensions::SetHeight ( const ULWord  inValue )

inline

Sets my height dimension.

Parameters

[in]

inValue

Specifies the new height dimension, in lines.

Returns

A non-constant reference to me.

Definition at line 5686 of file ntv2publicinterface.h.

SetWidth()

NTV2FrameDimensions& NTV2FrameDimensions::SetWidth ( const ULWord  inValue )

inline

Sets my width dimension.

Parameters

[in]

inValue

Specifies the new width dimension, in pixels.

Returns

A non-constant reference to me.

Definition at line 5679 of file ntv2publicinterface.h.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2publicinterface.h