#include <c4d_tools.h>
A rendering bitmap buffer. Represents internally the same class as MultipassBitmap, so a VPBuffer can be cast to a MultipassBitmap and vice versa.
|
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 |
|
◆ VPBuffer()
◆ ~VPBuffer()
◆ GetInfo()
Retrieves information about the videopost buffer.
- Parameters
-
[in] | type | The information type to get: VPGETINFO |
- Returns
- The information.
◆ GetLine()
Gets a line from the videopost buffer.
- Parameters
-
[in] | x | The starting horizontal position. |
[in] | y | The vertical position of the line. |
[in] | cnt | The width of the line to get. |
[in] | data | The buffer to fill with the data from the line. The caller owns the pointed buffer. |
[in] | bitdepth | The bit depth to use to fill the data buffer:
|
[in] | dithering | true if the line should be dithered. |
- Returns
- true if successful, otherwise false.
◆ SetLine()
Sets a line in the videopost buffer.
- Parameters
-
[in] | x | The starting horizontal position. |
[in] | y | The vertical position of the line. |
[in] | cnt | The width of the line to set. |
[in] | data | The buffer with the data to set the line. The caller owns the pointed buffer. |
[in] | bitdepth | The bit depth of data buffer:
|
[in] | dithering | true if the line should be dithered. |
- Returns
- true if successful, otherwise false.
◆ GetBw()
Gets the width of the videopost buffer.
- Returns
- The width.
◆ GetBh()
Gets the height of the videopost buffer.
- Returns
- The height.
◆ GetBt()
Gets the bit depth of the videopost buffer.
- Returns
- The bit depth:
◆ GetCpp()
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.