HP SVA V2.0 Parallel Compositing Reference Guide

pcContextSetString(3)
NAME
pcContextSetString -- Sets a string context property.
Synopsis
PCerr pcContextSetString(
PCcontext ctx,
PCenum property,
PCint hostIndex,
PCstring value
);
Parameters
ctx
The context whose properties are to be set.
property
The property to set.
The names of the supported properties are listed in Table 2-7 in the Parallel
Compositing Library Reference Guide and denoted as “Can Change After Context
Create.”
hostIndex
For host-specific properties, this parameter lets you specify the index of the host
whose property you want. Host-specific properties are marked as such in Table 2-7
in the Parallel Compositing Library Reference Guide.
Each host is assigned a hostIndex between 0 and PC_NUM_HOSTS - 1. The
Library also defines a few hostIndex constants that can be used for this
parameter:
PC_LOCALHOST_INDEX equals hostIndex of the host making the call.
PC_MASTER_INDEX equals hostIndex of the master host.
PC_INDEX_DEFAULT equals PC_LOCALHOST_INDEX.
This parameter is ignored for global properties.
value
The value to assign to the property.
Returns
This function returns PC_NO_ERROR on successful completion.
Description
This function is called to set the current value of a context property. Context properties fall in
one of two categories:
Global: The property is the same for all hosts.
Host-specific: The property can be different for each host.
The hostIndex parameter is ignored when you set the value of a global property. For a host-specific
property, the hostIndex parameter specifies which host’s property you want to set. Several
additional constants are also provided for common hostIndexes. These can be used in place of
the specific index for these common hosts.
Host-specific versus global properties are marked as such in Table 2-7 in the Parallel Compositing
Library Reference Guide.
Not all Context Properties can be set by this function.
• Certain properties can only be set when the context is created. See Section 2.5 in the Parallel
Compositing Library Reference Guide for details on setting context properties.
• Context parameters cannot be set between pcFrameBegin and pcFrameEnd.
54