VPBuffer Class Reference

#include <c4d_tools.h>

Detailed Description

A rendering bitmap buffer. Represents internally the same class as MultipassBitmap, so a VPBuffer can be cast to a MultipassBitmap and vice versa.

Public Member Functions

Int32 GetInfo (VPGETINFO type) const
 
Bool GetLine (Int32 x, Int32 y, Int32 cnt, void *data, Int32 bitdepth, Bool dithering) const
 
Bool SetLine (Int32 x, Int32 y, Int32 cnt, void *data, Int32 bitdepth, Bool dithering) const
 
Int32 GetBw () const
 
Int32 GetBh () const
 
Int32 GetBt () const
 
Int32 GetCpp () const
 
Bool GetVisibleBit () const
 

Private Member Functions

 VPBuffer ()
 
 ~VPBuffer ()
 

Constructor & Destructor Documentation

◆ VPBuffer()

VPBuffer ( )
private

◆ ~VPBuffer()

~VPBuffer ( )
private

Member Function Documentation

◆ GetInfo()

Int32 GetInfo ( VPGETINFO  type) const

Retrieves information about the videopost buffer.

Parameters
[in]typeThe information type to get: VPGETINFO
Returns
The information.

◆ GetLine()

Bool GetLine ( Int32  x,
Int32  y,
Int32  cnt,
void *  data,
Int32  bitdepth,
Bool  dithering 
) const

Gets a line from the videopost buffer.

Parameters
[in]xThe starting horizontal position.
[in]yThe vertical position of the line.
[in]cntThe width of the line to get.
[in]dataThe buffer to fill with the data from the line. The caller owns the pointed buffer.
[in]bitdepthThe bit depth to use to fill the data buffer:
[in]ditheringtrue if the line should be dithered.
Returns
true if successful, otherwise false.

◆ SetLine()

Bool SetLine ( Int32  x,
Int32  y,
Int32  cnt,
void *  data,
Int32  bitdepth,
Bool  dithering 
) const

Sets a line in the videopost buffer.

Parameters
[in]xThe starting horizontal position.
[in]yThe vertical position of the line.
[in]cntThe width of the line to set.
[in]dataThe buffer with the data to set the line. The caller owns the pointed buffer.
[in]bitdepthThe bit depth of data buffer:
[in]ditheringtrue if the line should be dithered.
Returns
true if successful, otherwise false.

◆ GetBw()

Int32 GetBw ( ) const

Gets the width of the videopost buffer.

Returns
The width.

◆ GetBh()

Int32 GetBh ( ) const

Gets the height of the videopost buffer.

Returns
The height.

◆ GetBt()

Int32 GetBt ( ) const

Gets the bit depth of the videopost buffer.

Returns
The bit depth:

◆ GetCpp()

Int32 GetCpp ( ) const

Gets the bytes per pixel for the videopost buffer.

Returns
The number of bytes per pixel.

◆ GetVisibleBit()

Bool GetVisibleBit ( ) const

Determines whether the videopost buffer is visible.

Note
Buffers that were requested by plugins can be existent, but invisible (not listed in the Picture Viewer Multipass menu).
Returns
true if the buffer is visible, otherwise false.