HP SVA V2.0 Parallel Compositing Reference Guide

pcFrameAddFramelet(3)
NAME
pcFrameAddFramelet -- Adds a framelet to the frame.
Synopsis
PCerr pcFrameAddFramelet(
PCcontext ctx,
PCid frameId,
PCvoidp color,
PCvoidp depth
);
Parameters
ctx
The context for this frame.
frameId The unique ID generated for this frame by pcFrameBegin.
color
A pointer to the buffer containing the color pixels for this framelet.
depth
A pointer to the buffer containing the depth data for the pixels of this framelet.
Returns
This function returns PC_NO_ERROR on successful completion.
Description
This function adds a framelet to the frame. It corresponds to the Add the Framelet to the Frame
Step in Table 1-2 (page 15) of the Parallel Compositing Reference Guide.
The number of times this function is called for this frame is given by the numFramelets parameter
specified on this frame’s pcFrameBegin call. This might be 0 if this host is not rendering any
framelets. The ith call to this function specifies the pixel data that corresponds to the ith framelet.
Note that the number of framelets per frame can change from frame to frame.
The color and depth parameters point to arrays of pixel data for this framelet. The format of this
data is dictated by the PC_PIXEL_FORMAT context property. In general, you want to choose a
format that is efficient for the application to generate. If the type of compositing specified by the
PC_COMPOSITE_TYPE context property requires no depth data, the depth parameter should be
NULL.
The buffers passed to pcFrameAddFramelet are normally not modified by the Library and
they can be reused by the caller on return from this function.
The PC_VOLATILE_FRAMELET context property grants the Library the right to relax the normal
behavior. If the value of PC_VOLATILE_FRAMELET is greater than 0, the Library is permitted
to modify the framelet and the caller won’t modify the framelet until after
PC_VOLATILE_FRAMELET calls to pcFrameBegin.
58