VPBuffer Class Reference

#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 ()

构造函数 & 析构函数文档编制

◆  VPBuffer()

VPBuffer () private

◆  ~VPBuffer()

~ VPBuffer () private

成员函数文档编制

◆  GetInfo()

Int32 GetInfo ( VPGETINFO   type ) const

Retrieves information about the videopost buffer.

参数
[in] type The information type to get: VPGETINFO
返回
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.

参数
[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.
返回
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.

参数
[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.
返回
true if successful, otherwise false .

◆  GetBw()

Int32 GetBw ( ) const

Gets the width of the videopost buffer.

返回
The width.

◆  GetBh()

Int32 GetBh ( ) const

Gets the height of the videopost buffer.

返回
The height.

◆  GetBt()

Int32 GetBt ( ) const

Gets the bit depth of the videopost buffer.

返回
The bit depth:

◆  GetCpp()

Int32 GetCpp ( ) const

Gets the bytes per pixel for the videopost buffer.

返回
The number of bytes per pixel.

◆  GetVisibleBit()

Bool GetVisibleBit ( ) const

Determines whether the videopost buffer is visible.

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