This class defines the parameters needed to interpret the frame data associated with a clip node. More...
Inherited by WireTapAudioFormat.
Public Types | |
enum | ScanFormat { SCAN_FORMAT_UNKNOWN = -1, SCAN_FORMAT_FIELD_1_ODD = 0, SCAN_FORMAT_FIELD_1_EVEN, SCAN_FORMAT_FIELD_2_ODD, SCAN_FORMAT_FIELD_2_EVEN, SCAN_FORMAT_PROGRESSIVE, NUM_SCAN_FORMATS } |
Specifies the field dominance and video standard of the clip. ODD indicates NTSC is the video standard of the clip. EVEN indicates PAL is the video standard of the clip. More... | |
Public Member Functions | |
int | bitsPerChannel () const |
Gets the number of bits assigned to each channel in a frame; applies to image formats only. More... | |
int | bitsPerPixel () const |
Gets the number of bits used to represent a single pixel in a frame; applies to image formats only. More... | |
const char * | colourSpace () const |
Gets the colour space; applies to image formats only. More... | |
const char * | formatTag () const |
Gets the tag that describes the format of the frames in the clip, such as "rgb", "jpg" or "aiff". More... | |
size_t | frameBufferSize () const |
Gets the size (in bytes) of the buffer needed to store a frame in the format. More... | |
float | frameRate () const |
Gets the number of frames displayed per second; applies to image formats only. More... | |
int | height () const |
Gets the height of the frame buffer; applies to image formats only. More... | |
const char * | metaData () const |
Gets the ASCII metadata stream for the current clip format, if one has been defined. More... | |
const char * | metaDataTag () const |
Gets a tag that describes the format of a metadata stream if metadata is associated with the current clip format. More... | |
int | numChannels () const |
Gets the number of channels in a pixel of a frame; applies to image formats only. More... | |
WireTapClipFormat & | operator= (const WireTapClipFormat &src) |
Default assignment operator. More... | |
float | pixelRatio () const |
Gets the aspect ratio of pixels in a frame; applies to image formats only. More... | |
ScanFormat | scanFormat () const |
Gets the scan format for the current clip format; applies to video formats only. More... | |
void | setBitsPerPixel (int bits) |
Sets the number of bits used to represent a single pixel in a frame; applies to image formats only. More... | |
void | setColourSpace (const char *colourSpace) |
Sets the colour space; applies to image formats only. More... | |
void | setFormatTag (const char *formatTag) |
Sets the tag that describes the format of the frames in the clip, such as "rgb", "jpg" or "aiff". More... | |
void | setFrameBufferSize (size_t size) |
Sets the size of the buffer (in bytes) needed to store a frame in the format being described. More... | |
void | setFrameRate (float rate) |
Sets the number of frames displayed per second; applies to image formats only. More... | |
void | setHeight (int height) |
Sets the height of the frame buffer; applies to image formats only. More... | |
void | setMetaData (const char *metadataStream) |
Sets an ASCII metadata stream for the current clip format. More... | |
void | setMetaDataTag (const char *metadataTag) |
Sets a tag that describes the format of the metadata stream, if metadata is associated with the current clip format. More... | |
void | setNumChannels (int numChannels) |
Sets the number of channels in a pixel of a frame; applies to image formats only. More... | |
void | setPixelRatio (float ratio) |
Sets the aspect ratio of pixels in a frame; applies to image formats only. More... | |
void | setScanFormat (ScanFormat scanFormat) |
Sets the scan format for the current clip format; applies to image formats only. More... | |
void | setWidth (int width) |
Sets the width of the frame buffer; applies to image formats only. More... | |
int | width () const |
Gets the width of the frame buffer; applies to image format only. More... | |
WireTapClipFormat () | |
Constructs a WireTapClipFormat object. More... | |
WireTapClipFormat (int frameWidth, int frameHeight, int bitsPerPixel, int numChannels, size_t frameBufferSize, float frameRate, float pixelRatio, ScanFormat scanFormat, const char *formatTag, const char *metadataTag=0, const char *metadata=0) | |
Constructs a WireTapClipFormat object from key parameters (including the size of the frame buffer). More... | |
WireTapClipFormat (int frameWidth, int frameHeight, int bitsPerPixel, int numChannels, float frameRate, float pixelRatio, ScanFormat scanFormat, const char *formatTag, const char *metadataTag=nullptr, const char *metadata=nullptr) | |
Constructs a WireTapClipFormat object from key parameters (excluding the size of the frame buffer). More... | |
WireTapClipFormat (int frameWidth, int frameHeight, int bitsPerPixel, int numChannels, const char *colourSpace, float frameRate, float pixelRatio, ScanFormat scanFormat, const char *formatTag, const char *metadataTag=nullptr, const char *metadata=nullptr) | |
Constructs a WireTapClipFormat object from key parameters (excluding the size of the frame buffer). More... | |
WireTapClipFormat (const WireTapClipFormat &format) | |
Copy constructor. Constructs a new WireTapClipFormat object duplicating the content of the original. More... | |
virtual | ~WireTapClipFormat () |
Destructor. More... | |
Static Public Member Functions | |
static const char * | FORMAT_AIFC () |
static const char * | FORMAT_AIFF () |
static const char * | FORMAT_ALIAS () |
static const char * | FORMAT_CINEON () |
static const char * | FORMAT_DL_AUDIO () |
static const char * | FORMAT_DL_AUDIO_FLOAT () |
static const char * | FORMAT_DL_AUDIO_FLOAT_LE () |
static const char * | FORMAT_DL_AUDIO_INT16 () |
static const char * | FORMAT_DL_AUDIO_INT16_LE () |
static const char * | FORMAT_DL_AUDIO_INT24 () |
static const char * | FORMAT_DL_AUDIO_INT24_LE () |
static const char * | FORMAT_DL_AUDIO_INT24_MSB32_LE () |
static const char * | FORMAT_DL_AUDIO_INT8 () |
static const char * | FORMAT_DL_AUDIO_INT8_UNSIGNED () |
static const char * | FORMAT_DL_AUDIO_MIXED () |
static const char * | FORMAT_DPX () |
static const char * | FORMAT_HLS () |
static const char * | FORMAT_HLS_LE () |
static const char * | FORMAT_HLSA () |
static const char * | FORMAT_HLSA_LE () |
static const char * | FORMAT_JPEG () |
static const char * | FORMAT_MAYA () |
static const char * | FORMAT_MIXED () |
static const char * | FORMAT_MONO () |
static const char * | FORMAT_MONO_FLOAT () |
static const char * | FORMAT_MONO_FLOAT_LE () |
static const char * | FORMAT_MONO_LE () |
static const char * | FORMAT_OPENEXR () |
static const char * | FORMAT_PHOTOSHOP () |
static const char * | FORMAT_PICT () |
static const char * | FORMAT_PIXAR () |
static const char * | FORMAT_RGB () |
static const char * | FORMAT_RGB_FLOAT () |
static const char * | FORMAT_RGB_FLOAT_LE () |
static const char * | FORMAT_RGB_LE () |
static const char * | FORMAT_RGBA () |
static const char * | FORMAT_RGBA_FLOAT () |
static const char * | FORMAT_RGBA_FLOAT_LE () |
static const char * | FORMAT_RGBA_LE () |
static const char * | FORMAT_SGI () |
static const char * | FORMAT_SOFTIMAGE () |
static const char * | FORMAT_TARGA () |
static const char * | FORMAT_TDI () |
static const char * | FORMAT_TIFF () |
static const char * | FORMAT_UYVY () |
static const char * | FORMAT_UYVY_LE () |
static const char * | FORMAT_WAV () |
static const char * | FORMAT_WAVEFRONT () |
static const char * | FORMAT_YUV () |
static const char * | FORMAT_YUV_LE () |
static const char * | FORMAT_YUVA () |
static const char * | FORMAT_YUVA_LE () |
static const char * | SCAN_FORMAT_FIELD_1_EVEN_STR () |
Class method that gets a string that describes a PAL interlaced scan format. More... | |
static const char * | SCAN_FORMAT_FIELD_1_ODD_STR () |
Class method that gets a string that describes an NTSC interlaced scan format. More... | |
static const char * | SCAN_FORMAT_FIELD_2_EVEN_STR () |
Class method that gets a string that describes a PAL interlaced scan format. More... | |
static const char * | SCAN_FORMAT_FIELD_2_ODD_STR () |
Class method that gets a string that describes an NTSC interlaced scan format. More... | |
static const char * | SCAN_FORMAT_PROGRESSIVE_STR () |
Class method that gets a string that describes the progressive scan format. More... | |
static const char * | SCAN_FORMAT_UNKNOWN_STR () |
Class method that gets a string that indicates the scan format is not known. More... | |
static const char * | scanFormatStr (ScanFormat format) |
Class method that converts a video scan format to a string. More... | |
static WireTapClipFormat::ScanFormat | strToScanFormat (const char *formatString) |
Class method that converts a string to a video scan format. More... | |
This class defines the parameters needed to interpret the frame data associated with a clip node.
WireTapClipFormat is designed to provide sufficient information to
interpret any data stream, with a focus on video frames. Its subclass WireTapAudioFormat serves the same purpose, but with a focus on audio frames.
Specifies the field dominance and video standard of the clip.
ODD indicates NTSC is the video standard of the clip. EVEN indicates PAL is the video standard of the clip.
WireTapClipFormat::WireTapClipFormat | ( | ) |
Constructs a WireTapClipFormat object.
WireTapClipFormat::WireTapClipFormat | ( | int | frameWidth, |
int | frameHeight, | ||
int | bitsPerPixel, | ||
int | numChannels, | ||
size_t | frameBufferSize, | ||
float | frameRate, | ||
float | pixelRatio, | ||
ScanFormat | scanFormat, | ||
const char * | formatTag, | ||
const char * | metadataTag = 0 , |
||
const char * | metadata = 0 |
||
) |
Constructs a WireTapClipFormat object from key parameters (including the size of the frame buffer).
frameWidth | An input parameter. The width of the frame buffer. The width of a video frame buffer (for example: YUV, RGB, and RGBA) is measured in pixels. |
frameHeight | An input parameter. The height of the frame buffer. The height of a video frame buffer is measured in pixels. |
bitsPerPixel | An input parameter. An integer that is the number of bits used to represent a single pixel in a video frame. For example, an 8-bit RGB frame has 24 bits per pixel (3 channels * 8 bits/channel). |
numChannels | An input parameter. An integer that is the number of channels in a pixel of a video frame. For example: RGB has 3 channels; RGBA has 4 channels. |
frameBufferSize | An input parameter. An integer that is the size (in bytes) of the buffer needed to store frames in the format being defined. |
frameRate | An input parameter. A float that is the number of frames displayed per second in a video clip. |
pixelRatio | An input parameter. A float that is the aspect ratio of pixels in the video format. This is not to be confused with the aspect ratio of the frame. |
scanFormat | An input parameter. One of the scan format constants defined in this class. For example: progressive. See WireTapClipFormat.ScanFormat. |
formatTag | An input parameter. A string that describes the format of frames in the video clip. For example: rgb. See Static Methods for Setting the Format Tag |
metadataTag | An input parameter. A string that describes the format of the metadata stream, if one is to be defined for the clip format. For example: xml. If metadata is not required, this parameter can be omitted, and it will default to 0. |
metadata | An input parameter. A string that contains the metadata for the clip format. If metadata is not required, this parameter can be omitted and it will default to 0. |
WireTapClipFormat::WireTapClipFormat | ( | int | frameWidth, |
int | frameHeight, | ||
int | bitsPerPixel, | ||
int | numChannels, | ||
float | frameRate, | ||
float | pixelRatio, | ||
ScanFormat | scanFormat, | ||
const char * | formatTag, | ||
const char * | metadataTag = nullptr , |
||
const char * | metadata = nullptr |
||
) |
Constructs a WireTapClipFormat object from key parameters (excluding the size of the frame buffer).
frameWidth | An input parameter. The width of the frame buffer. The width of a video frame buffer (for example: YUV, RGB, and RGBA) is measured in pixels. |
frameHeight | An input parameter. The height of the frame buffer. The height of a video frame buffer is measured in pixels. |
bitsPerPixel | An input parameter. An integer that is the number of bits used to represent a single pixel in a video frame. For example, an 8-bit RGB frame has 24 bits per pixel (3 channels * 8 bits/channel). |
numChannels | An input parameter. An integer that is the number of channels in a pixel of a video frame. For example: RGB has 3 channels; RGBA has 4 channels. |
frameRate | An input parameter. A float that is the number of frames displayed per second in a video clip. |
pixelRatio | An input parameter. A float that is the aspect ratio of pixels in the video format. This is not to be confused with the aspect ratio of the frame. |
scanFormat | An input parameter. One of the scan format constants defined in this class. For example: progressive. See WireTapClipFormat.ScanFormat. |
formatTag | An input parameter. A string that describes the format of frames in the video clip. For example: rgb. See Static Methods for Setting the Format Tag |
metadataTag | An input parameter. A string that describes the format of the metadata stream, if one is to be defined for the clip format. For example: xml. If metadata is not required, this parameter can be omitted, and it will default to nullptr. |
metadata | An input parameter. A string that contains the metadata for the clip format. If metadata is not required, this parameter can be omitted and it will default to nullptr. |
WireTapClipFormat::WireTapClipFormat | ( | int | frameWidth, |
int | frameHeight, | ||
int | bitsPerPixel, | ||
int | numChannels, | ||
const char * | colourSpace, | ||
float | frameRate, | ||
float | pixelRatio, | ||
ScanFormat | scanFormat, | ||
const char * | formatTag, | ||
const char * | metadataTag = nullptr , |
||
const char * | metadata = nullptr |
||
) |
Constructs a WireTapClipFormat object from key parameters (excluding the size of the frame buffer).
frameWidth | An input parameter. The width of the frame buffer. The width of a video frame buffer (for example: YUV, RGB, and RGBA) is measured in pixels. |
frameHeight | An input parameter. The height of the frame buffer. The height of a video frame buffer is measured in pixels. |
bitsPerPixel | An input parameter. An integer that is the number of bits used to represent a single pixel in a video frame. For example, an 8-bit RGB frame has 24 bits per pixel (3 channels * 8 bits/channel). |
numChannels | An input parameter. An integer that is the number of channels in a pixel of a video frame. For example: RGB has 3 channels; RGBA has 4 channels. |
colourSpace | An input parameter. A string representing the colour space to be applied to the allocated frames. |
frameRate | An input parameter. A float that is the number of frames displayed per second in a video clip. |
pixelRatio | An input parameter. A float that is the aspect ratio of pixels in the video format. This is not to be confused with the aspect ratio of the frame. |
scanFormat | An input parameter. One of the scan format constants defined in this class. For example: progressive. See WireTapClipFormat.ScanFormat. |
formatTag | An input parameter. A string that describes the format of frames in the video clip. For example: rgb. See Static Methods for Setting the Format Tag |
metadataTag | An input parameter. A string that describes the format of the metadata stream, if one is to be defined for the clip format. For example: xml. If metadata is not required, this parameter can be omitted, and it will default to nullptr. |
metadata | An input parameter. A string that contains the metadata for the clip format. If metadata is not required, this parameter can be omitted and it will default to nullptr. |
|
virtual |
Destructor.
WireTapClipFormat::WireTapClipFormat | ( | const WireTapClipFormat & | format | ) |
Copy constructor. Constructs a new WireTapClipFormat object duplicating the content of the original.
format | An input parameter. The WiretapServerInfo object that is to be copied. |
int WireTapClipFormat::bitsPerChannel | ( | ) | const |
Gets the number of bits assigned to each channel in a frame; applies to image formats only.
This value is derived from member variables as follows: bitsPerPixel / numChannels. The value is rounded down to the nearest bit.
int WireTapClipFormat::bitsPerPixel | ( | ) | const |
Gets the number of bits used to represent a single pixel in a frame; applies to image formats only.
For example, an 8-bit RGB frame has 24 bits per pixel (3 channels * 8 bits/channel).
For a non-video format, this method may get the number of bits in a unit that is relevant for the format (rather than in pixels).
const char* WireTapClipFormat::colourSpace | ( | ) | const |
Gets the colour space; applies to image formats only.
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
const char* WireTapClipFormat::formatTag | ( | ) | const |
Gets the tag that describes the format of the frames in the clip, such as "rgb", "jpg" or "aiff".
A Wiretap client must check this tag to determine how to interpret
frame data.
size_t WireTapClipFormat::frameBufferSize | ( | ) | const |
Gets the size (in bytes) of the buffer needed to store a frame in the format.
For example, an 8-bit NTSC RGB image would require: 486 * 720 * 3 * 1 bytes.
Wiretap clients need this value when allocating a buffer for reading and writing frames. The sample program createClip.cpp shows how to use this method.
See WireTapNodeHandle.readFrame and WireTapNodeHandle.writeFrame.
float WireTapClipFormat::frameRate | ( | ) | const |
Gets the number of frames displayed per second; applies to image formats only.
Typical values are 24, 29.97, and so on.
int WireTapClipFormat::height | ( | ) | const |
Gets the height of the frame buffer; applies to image formats only.
const char* WireTapClipFormat::metaData | ( | ) | const |
Gets the ASCII metadata stream for the current clip format, if one has been defined.
A clip format can optionally have free-form metadata to communicate extra formatting information. Wiretap clients obtain the metadata stream with this method. The stream is set with WireTapClipFormat.setMetaData.
If metadata has been defined, Wiretap clients can obtain its format
using WireTapClipFormat.metaDataTag. The format is set with the method WireTapClipFormat.setMetaDataTag.
const char* WireTapClipFormat::metaDataTag | ( | ) | const |
Gets a tag that describes the format of a metadata stream if metadata is associated with the current clip format.
A clip format can optionally have free-form metadata to communicate extra formatting information. The metadata tag determines the type or format of the metadata stream.
int WireTapClipFormat::numChannels | ( | ) | const |
Gets the number of channels in a pixel of a frame; applies to image formats only.
For example: RGB has 3 channels; RGBA has 4 channels.
WireTapClipFormat& WireTapClipFormat::operator= | ( | const WireTapClipFormat & | src | ) |
Default assignment operator.
Returns a reference to the source object.
src | An input parameter. The WireTapClipFormat object to which the reference should point. |
float WireTapClipFormat::pixelRatio | ( | ) | const |
Gets the aspect ratio of pixels in a frame; applies to image formats only.
This is not to be confused with the aspect ratio of the image or frame.
|
static |
Class method that gets a string that describes a PAL interlaced scan format.
See WireTapClipFormat::SCAN_FORMAT_FIELD_1_EVEN for a description of the format.
|
static |
Class method that gets a string that describes an NTSC
interlaced scan format.
See WireTapClipFormat::SCAN_FORMAT_FIELD_1_ODD for a description of the format.
|
static |
Class method that gets a string that describes a PAL interlaced scan format.
See WireTapClipFormat::SCAN_FORMAT_FIELD_2_EVEN for a description of the format.
|
static |
Class method that gets a string that describes an NTSC interlaced scan format.
See WireTapClipFormat::SCAN_FORMAT_FIELD_2_ODD for a description of the format.
|
static |
Class method that gets a string that describes the progressive scan format.
A progressive scan means the lines of each frame are drawn in sequence.
|
static |
Class method that gets a string that indicates the scan format is not known.
ScanFormat WireTapClipFormat::scanFormat | ( | ) | const |
Gets the scan format for the current clip format; applies to video formats only.
Video scan formats control how video frames are drawn. A format is either progressive (the lines of a frame are drawn in sequence) or interlaced (divided into two fields which are interlaced). For interlaced formats, the format also indicates which field is dominant.
|
static |
Class method that converts a video scan format to a string.
format | An input parameter. One of the scan format constants defined in this class. See WireTapClipFormat.ScanFormat. |
void WireTapClipFormat::setBitsPerPixel | ( | int | bits | ) |
Sets the number of bits used to represent a single pixel in a frame; applies to image formats only.
For example, an 8-bit RGB frame has 24 bits per pixel (3 channels * 8 bits/channel).
For a non-video format, this method may be used to set the number of bits in a unit that is relevant for the format (rather than in pixels).
bits | An input parameter. An integer that is the number of bits used to represent a single pixel in a video frame. |
void WireTapClipFormat::setColourSpace | ( | const char * | colourSpace | ) |
Sets the colour space; applies to image formats only.
colourSpace | An input parameter. A string representing the colourSpace being appplied to the frames. |
void WireTapClipFormat::setFormatTag | ( | const char * | formatTag | ) |
Sets the tag that describes the format of the frames in the clip, such as "rgb", "jpg" or "aiff".
Wiretap clients must check this format tag to determine how to
interpret frame data. The WireTapClipFormat.formatTag method returns the tag.
formatTag | An input parameter. A string that describes the format of frames in the video clip. See below for lists of the static methods of this class that can be used to set the format tag to standard formats. |
The following static methods are available for setting the format tag for some standard image file formats:
The following static methods can be used to set the format tag for raw image files:
The following static methods are available for setting the format tag for audio clips:
void WireTapClipFormat::setFrameBufferSize | ( | size_t | size | ) |
Sets the size of the buffer (in bytes) needed to store a frame in the format being described.
For example, an 8-bit NTSC RGB image would require: 486 * 720 * 3 * 1 bytes.
Wiretap clients need this value when allocating a buffer for reading and writing frames. See WireTapNodeHandle.readFrame and WireTapNodeHandle.writeFrame.
size | An input parameter. An integer that is the size (in bytes) of the buffer needed to store frames in the format being defined. |
void WireTapClipFormat::setFrameRate | ( | float | rate | ) |
Sets the number of frames displayed per second; applies to image formats only.
Typical values are 24, 29.97, and so on.
rate | An input parameter. A float that is the number of frames displayed per second. |
void WireTapClipFormat::setHeight | ( | int | height | ) |
Sets the height of the frame buffer; applies to image formats only.
height | An input parameter. The height of the frame buffer. The height of a video frame buffer (for example: YUV, RGB, and RGBA) is measured in pixels. |
void WireTapClipFormat::setMetaData | ( | const char * | metadataStream | ) |
Sets an ASCII metadata stream for the current clip format.
A clip format can optionally have free-form metadata to communicate extra formatting information. Wiretap clients obtain the stream with this method. And typically, Wiretap servers set the stream with WireTapClipFormat.setMetaData.
If metadata has been defined, Wiretap clients can obtain its format using WireTapClipFormat.metaDataTag. The format is set with the method WireTapClipFormat.setMetaDataTag.
metadataStream | An input parameter. A string that contains the metadata for the clip format. |
void WireTapClipFormat::setMetaDataTag | ( | const char * | metadataTag | ) |
Sets a tag that describes the format of the metadata stream, if metadata is associated with the current clip format.
A clip format can optionally have free-form metadata to communicate extra formatting information. The metadata tag determines the type or format of the metadata stream.
metadataTag | A string that describes the format of the metadata stream, if one has been defined for the clip format. For example: xml. |
void WireTapClipFormat::setNumChannels | ( | int | numChannels | ) |
Sets the number of channels in a pixel of a frame; applies to image formats only.
For example: RGB has 3 channels; RGBA has 4 channels.
numChannels | An input parameter. An integer that is the number of channels in a pixel of a video frame. |
void WireTapClipFormat::setPixelRatio | ( | float | ratio | ) |
Sets the aspect ratio of pixels in a frame; applies to image formats only.
This is not to be confused with the image or frame aspect ratio.
ratio | An input parameter. A float that is the aspect ratio of pixels in the video format. |
void WireTapClipFormat::setScanFormat | ( | ScanFormat | scanFormat | ) |
Sets the scan format for the current clip format; applies to image formats only.
Video scan formats control how video frames are drawn. A format is either progressive (the lines of a frame are drawn in sequence) or interlaced (divided into two fields which are interlaced). For interlaced formats, the format also indicates which field is dominant.
scanFormat | An input parameter. One of the scan format constants defined in this class. See WireTapClipFormat.ScanFormat. |
void WireTapClipFormat::setWidth | ( | int | width | ) |
Sets the width of the frame buffer; applies to image formats only.
width | An input parameter. The width of the frame buffer. The width of a video frame buffer (for example: YUV, RGB, and RGBA) is measured in pixels. |
|
static |
Class method that converts a string to a video scan format.
formatString | An input parameter. A string that describes a video scan format. |
int WireTapClipFormat::width | ( | ) | const |
Gets the width of the frame buffer; applies to image format only.