@database MPRender-rexx
@rem created by makedoc
@node main

@{"MPRender/--background--" link "--background--"}
@{"MPRender/GETATTR" link "GETATTR"}
@{"MPRender/SETATTR" link "SETATTR"}


@endnode
@node "--background--" "MPRender/--background--"

--background-- :


  The default portname for MPRender is MPRENDER. This can be overidden by
  the PORTNAME parameter. However you should never need to address the port
  directly as all commands should only be run from PRESCRIPT scripts which
  will automatically use the correct port.

  If 'OPTIONS RESULTS' is on then when an error is returned then RC2 will
  hold a supplementary error (number or text).

  Shortened unique formats of commands can be used.

@endnode
@node "GETATTR" "MPRender/GETATTR"

GETATTR :


   NAME   
  GETATTR -- Gets the attributes of a variable

   SYNOPSIS
  GETATTR( VAR/K,STEM/K,BASEADDRESS/A,NAME/A ) => VALUE

   FUNCTION
  Returns the current value of a specified field.

   INPUTS
  VAR         - Variable to return result rather than RESULT.
  STEM        - Stem variable for result.
  BASEADDRESS - As returned by - parse arg Base -.
  NAME        - Name of variable to get attributes of:
                Frame    - Current frame number - starting at 1
                              (0 for first frame);
                TotalFrames - total number of frames;
                Single   - the type of morph
                              0 - Morph, 1 - Warp
                              2 - AnimMorph, 3 - AnimWarp;
                Movement - 0 to 1024 - the proportion of movement
                              from the first image to the second image;
                Red1     - 0 to 1024 the proportion of image 1 Red to use;
                Green1   - As Red1 for Green;
                Blue1    - As Red1 for Blue;
                Red2     - 0 to 1024 the proportion of image 2 Red to use;
                Green2   - As Red2 for Green;
                Blue2    - As Red2 for Blue;
                Produce  - 1 to render the frame - 0 to skip;
                RPlus    - 0 to 255 to add to Red in rendered image;
                GPlus    - As RPlus for Green;
                BPlus    - As RPlus for Blue;
                RMinus   - 0 to 255 to subtract from Red in rendered image;
                GMinus   - As RMinus for Green;
                BMinus   - As RMinus for Blue;
                DX       - 0 to ? - X amount to skip;
                DY       - 0 to ? - Y amount to skip;
                Start    - Starting from number.

   RESULT
  If STEM is provided then result is returned in stem.value, otherwise
  if VAR is provided then result is in var, otherwise result is in
  RESULT;

  Returns error 10 if no memory or invalid NAME.

   EXAMPLE
  parse arg Base;options results;getattr Base Frame var f;say f

   NOTES
  Should only be called from PRESCRIPT scripts.
  It is a good idea to call - Numeric digits 12 - for correct processing
  of BASEADDRESS.

   BUGS
  Does not validate that a valid BASADDRESS is passed.

   SEE ALSO
  SETATTR().

@endnode
@node "SETATTR" "MPRender/SETATTR"

SETATTR :


   NAME   
  SETATTR -- Sets the attributes of a variable etc.

   SYNOPSIS
  SETATTR( BASEADDRESS/A,NAME/A,VALUE/A )

   FUNCTION
  Sets the current value of a specified field.

   INPUTS
  BASEADDRESS - As returned by - parse arg Base -.
  NAME        - Name of variable to set attributes for:
                Movement - 0 to 1024 - the proportion of movement
                              from the first image to the second image;
                Red1     - 0 to 1024 the proportion of image 1 Red to use;
                Green1   - As Red1 for Green;
                Blue1    - As Red1 for Blue;
                Red2     - 0 to 1024 the proportion of image 2 Red to use;
                Green2   - As Red2 for Green;
                Blue2    - As Red2 for Blue;
                Produce  - 1 to render the frame - 0 to skip;
                RPlus    - 0 to 255 to add to Red in rendered image;
                GPlus    - As RPlus for Green;
                BPlus    - As RPlus for Blue;
                RMinus   - 0 to 255 to subtract from Red in rendered image;
                GMinus   - As RMinus for Green;
                BMinus   - As RMinus for Blue;
                DX       - 0 to ? - X amount to skip;
                DY       - 0 to ? - Y amount to skip.
  VALUE       - Value to use.

   RESULT
  Returns error 10 if invalid NAME.

   EXAMPLE
  parse arg Base;SetAttr Base RMinus 12

   NOTES
  Should only be called from PRESCRIPT scripts.
  It is a good idea to call - Numeric digits 12 - for correct processing
  of BASEADDRESS.

   BUGS
  Allows setting of read only variables (i.e. those listed in GETATTR()
  which are not listed here). Does not validate that a valid BASADDRESS
  is passed.

   SEE ALSO
  GETATTR().

@endnode
