The RPF BitmapIO class provides a function published interface for RPF I/O that gives access to the settings of the image format to be saved.

As with all FP interfaces, you can access the interface properties directly without explicitly supplying the interface name, for example rpf.colorDepth is the same but shorter than rpf.iRPFio.colorDepth

Interfaces

Interface: rpf.iRPFio

Properties

.colorDepth : integer : Read|Write

Get/Set the color depth in bits per channel. Possible values are 8, 16 and 32.

.alpha : boolean : Read|Write

Enable/Disable the saving of alpha channel.

.premultAlpha : boolean : Read|Write

Enable/Disable premultiplied alpha.

.description : string : Read|Write

Get/Set the file description string.

.author : string : Read|Write

Get/Set the author string.

.zChannel : boolean : Read|Write

Get/Set Z-buffer channel saving.

.mtlIDChannel : boolean : Read|Write

Enable/Disable material ID channel saving.

.nodeIDChannel : boolean : Read|Write

Enable/Disable node ID channel saving.

.uvChannel : boolean : Read|Write

Enable/Disable texture coordinates channel saving.

.normalChannel : boolean : Read|Write

Enable/Disable normal vector channel saving.

.realpixChannel : boolean : Read|Write

Enable/Disable non-clamped color channel saving.

.coverageChannel : boolean : Read|Write

Enable/Disable coverage channel saving.

.nodeRenderIDChannel : boolean : Read|Write

Enable/Disable node render ID channel saving.

.colorChannel: boolean : Read|Write

Enable/Disable color channel saving.

.transpChannel : boolean : Read|Write

Enable/Disable transparency channel saving.

.velocChannel : boolean : Read|Write

Enable/Disable velocity channel saving.

.weightChannel : boolean : Read|Write

Enable/Disable sub-pixel weight channel saving.

.maskChannel : boolean : Read|Write

Enable/Disable sub-pixel mask channel saving.

EXAMPLE

   x = rpf.colorDepth--color depth value of 8, 16, or 32
   rpf.colorDepth = 32--set color depth to 8bpp
   rpf.description ="Final Rendering"--set the file description string
   rpf.author ="Da Masta of Pixelz"--set the author name string
   rpf.zChannel = true--enable Z-Buffer saving