RealityServer® 6.4

compositor_composite_components

Creates final composited images by combining multiple image components generated with composite rendering commands. Manipulations to each components such as colour or texture tints can be made by populating the operations map. Before compositing the composite must be prepared with the composite_prepare_composite command.

arguments

• "composite_name" : String

  Name to identify the composite which has previously been computed. The composite must either exist on disk or be already in the database.
  

• "format" : String (default: "jpg")

  The image format to return.
  

  Possible Values:

  • jpg
  • png
  • tif
  • exr
  • hdr
  • ct
  • array

• "operation" : Map

  Map containing the configuration of the components in the composite.
  

• "pixel_type" : String (default: "Rgba")

  The pixel type of the returned image.
  

  Possible Values:

  • Rgb
  • Rgba
  • Rgb_fp
  • Color
  • Rgbe
  • Rgbea
  • Rgba_16
  • Rgb_16
  • Sint8
  • Sint32
  • Float32
  • Float32<2>
  • Float32<3>
  • Float32<4>

• "quality" : String (default: "90")

  The quality of the returned image.
  

• "resolution" : Uint32<2> (default: null)

  Resolution of the output image.
  

• "samples" : Sint32 (default: null)

  Number of iterations to render. Increasing this can help with texture filtering in some cases when using textured tints.
  

• "storage_scope" : String (default: null)

  If provided the textures, images and attribute container containing the composite information will be read from this scope instead of the scope the command is run in.
  

return value

The rendered image result.

groups

• compositor
• render