From K-3D

Jump to: navigation, search


Displays a bitmap image in the background of the viewport.
Plugin Status:Stable
Categories:All Plugins, Stable Plugins, Annotation Plugins


Name Value


Label Description Type Script Name
Color Color k3d::color color
Opacity Opacity k3d::double_t opacity
Camera Camera k3d::inode* camera
Bitmap Bitmap k3d::bitmap* bitmap
Aspect Ratio Type Aspect Ratio Type k3d::string_t aspect_ratio_type
Aspect Ratio Aspect Ratio k3d::double_t aspect_ratio


ReferenceImage2D can be used to place bitmap images in the background of a viewport, for use as a reference during modeling and layout:


  • Create a bitmap source to supply the image, typically BitmapReader. Select the image to be displayed.
  • Create an instance of ReferenceImage2D.
  • In the Camera property, select the camera that will display the reference image.
  • Connect the Bitmap property to the output of your bitmap source.
  • Adjust the Opacity property to suit your preferences.
  • Use the Aspect Ratio Type property to control whether the image will be displayed using its own aspect ratio (good for tracing logos), or stretched to fit the aspect ratio of the rendered output (good for doing scene layout).
  • Use the Aspect Ratio property to manually adjust the aspect ratio of the image.

Tips & Tricks

  • Use the Color property to alter the color of the displayed image.
  • Use the BitmapChecker source to display checkerboard patterns in the viewport.
  • When using ReferenceImage2D to trace logos or do modeling, enable the Camera Orthographic property for accuracy.

See Also