ref_struct_VDXBitmap - shekh/VirtualDub2 GitHub Wiki

VirtualDub Plugin SDK 1.2

VDXBitmap structure

Structure used to describe a frame buffer used as sources or outputs during video filter operation.

class VDXBitmap {
public:
    void *      _vtable;
    uint32 *    data;
    uint32 *    palette;
    sint32      depth;
    sint32      w;
    sint32      h;
    ptrdiff_t   pitch;
    ptrdiff_t   modulo;
    ptrdiff_t   size;
    ptrdiff_t   offset;

    uint32 *Address32(int x, int y) const;
    uint32 *Address32i(int x, int y) const;

    void AlignTo4();
    void AlignTo8();
};

_vtable
Reserved for backwards compatibility; do not use.

data
Pointer to the start of the bottom-most scan line in the bitmap.

palette
Reserved for indexed color operation; set to NULL.

depth
Pixel depth, in bits. This value is set to 32 for a XRGB8888 format bitmap. If this value is 0, the pixmap structure in the VDXFBitmap structure takes precedence.

w
Width of the bitmap, in pixels. Cannot be negative.

h
Height of the bitmap, in pixels. Cannot be negative.

pitch
Byte offset from the beginning of one scan line to the next, going up the bitmap. For a bitmap stored in bottom-up orientation, this value is positive.

modulo
Byte offset from the end of one scan line to the beginning of the next. This value is 0 for scan lines stored back-to-back in bottom-up orientation.

size
The total size of the bitmap, in bytes, not including any offset.

offset
Offset from the beginning of the frame buffer to the beginning of the bitmap. This is used to offset the bitmap within the buffer to align it against an existing layout.

The VDXBitmap structure is a structure used to describe an image in memory in older versions of the video filter API. It has been superceded by VDXPixmap starting with the V12 API due to its inflexibility with regard to representing YCbCr or planar formats.

Copyright (C) 2007-2012 Avery Lee.