Home       Trees       Index       Help   

Blender

Module Render
[frames | no frames]

Module Render

The Blender.Scene.Render submodule.

Scene.Render

This module provides access to Scene Rendering Contexts in Blender.

Example: 
 import Blender
 from Blender import *
 from Blender.Scene import Render
 
 scn = Scene.GetCurrent()
 context = scn.getRenderingContext()
 
 Render.EnableDispWin()
 context.extensions = True
 context.renderPath = "//myRenderdir/"
 context.sizePreset(Render.PC)
 context.imageType = Render.AVIRAW
 context.sFrame = 2
 context.eFrame = 10
 context.renderAnim()
 
 context.imageType = Render.TARGA
 context.fps = 15
 context.sFrame = 15
 context.eFrame = 22
 context.renderAnim()
 
 Render.CloseRenderWindow()
 print context.fps
 print context.cFrame
Classes
RenderData This object gives access to Scene rendering contexts in Blender.

Function Summary
  CloseRenderWindow()
Closes the rendering window.
  EnableDispView()
Render in the 3d View area.
  EnableDispWin()
Render in Render window.
  EnableEdgeAll()
Globally consider transparent faces for edge-rendering with the unified renderer.
  EnableEdgeShift()
Globally with the unified renderer enabled the outlines of the render are shifted a bit.
  SetRenderWinPos(locationList)
Set the position of the Render window on the screen.

Variable Summary
  AVICODEC: Output format.
  AVIJPEG: Output format.
  AVIRAW: Output format.
  B_PR_FULL: Output format.
  BEST: Yafray GI Quality.
  BMP: Output format.
  CINEON: Output format.
  DEFAULT: Output format.
  DPX: Output format.
  FFMPEG: Output format.
readonly dictionary FramingModes: Constant dict used for with RenderData.gameFrame attribute.
  FTYPE: Output format.
  GIFULL: Yafray GI Quality.
  HAMX: Output format.
  HDR: Output format.
  HIGH: Yafray GI Quality.
  HIGHER: Yafray GI Quality.
  INTERNAL: The internal rendering engine.
  IRIS: Output format.
  IRISZ: Output format.
  JPEG: Output format.
  LOW: Yafray GI Quality.
  MEDIUM: Yafray GI Quality.
readonly dictionary Modes: Constant dict used for with RenderData.mode bitfield attribute.
  NONE: Yafray GI Quality.
  NTSC: Output format.
  OPENEXR: Output format.
  PAL: Output format.
  PAL169: Output format.
  PC: Output format.
  PNG: Output format.
  PREVIEW: Output format.
  QUICKTIME: Output format.
  RAWTGA: Output format.
readonly dictionary SceModes: Constant dict used for with RenderData.sceneMode bitfield attribute.
  SKYDOME: Yafray GI Quality.
  TARGA: Output format.
  TIFF: Output format.
  YAFRAY: Yafray rendering engine.

Function Details

CloseRenderWindow()

Closes the rendering window.

EnableDispView()

Render in the 3d View area. Note this method is deprecated; use the l{displayMode} attribute instead.

EnableDispWin()

Render in Render window. Note this method is deprecated; use the l{displayMode} attribute instead.

EnableEdgeAll()

Globally consider transparent faces for edge-rendering with the unified renderer.

EnableEdgeShift()

Globally with the unified renderer enabled the outlines of the render are shifted a bit.

SetRenderWinPos(locationList)

Set the position of the Render window on the screen. Possible values are:
  • S = south
  • N = north
  • W = west
  • E = east
  • C = center
  • ne = northeast
  • nw = northwest
  • se = southeast
  • sw = southwest
Parameters:
locationList - a list of strings that together define the location of the Render window on the screen.
           (type=PyList of strings)

Variable Details

AVICODEC

Output format. Use with renderdata.imageType / setImageType()

AVIJPEG

Output format. Use with renderdata.imageType / setImageType()

AVIRAW

Output format. Use with renderdata.imageType / setImageType()

B_PR_FULL

Output format. Use with renderdata.sizePreset()

BEST

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

BMP

Output format. Use with renderdata.imageType / setImageType()

CINEON

Output format. Use with renderdata.imageType / setImageType()

DEFAULT

Output format. Use with renderdata.sizePreset()

DPX

Output format. Use with renderdata.imageType / setImageType()

FFMPEG

Output format. Use with renderdata.imageType / setImageType()

FramingModes

Constant dict used for with RenderData.gameFrame attribute. One of the following modes can be active:
  • BARS: Show the entire viewport in the display window, using bar horizontally or vertically.
  • EXTEND: Show the entire viewport in the display window, viewing more horizontally or vertically
  • SCALE: Stretch or squeeze the viewport to fill the display window.
Type:
readonly dictionary

FTYPE

Output format. Use with renderdata.imageType / setImageType()

GIFULL

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

HAMX

Output format. Use with renderdata.imageType / setImageType()

HDR

Output format. Use with renderdata.imageType / setImageType()

HIGH

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

HIGHER

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

INTERNAL

The internal rendering engine. Use with setRenderer()

IRIS

Output format. Use with renderdata.imageType / setImageType()

IRISZ

Output format. Use with renderdata.imageType / setImageType()

JPEG

Output format. Use with renderdata.imageType / setImageType()

LOW

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

MEDIUM

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

Modes

Constant dict used for with RenderData.mode bitfield attribute. Values can be ORed together. Individual bits can also be set/cleared with boolean attributes.
  • OSA: Oversampling (anti-aliasing) enabled
  • SHADOW: Shadow calculation enabled
  • GAMMA: Gamma correction enabled
  • ENVMAP: Environment map rendering enabled
  • TOONSHADING: Toon edge shading enabled
  • FIELDRENDER: Field rendering enabled
  • FIELDTIME: Time difference in field calculations disabled
  • RADIOSITY: Radiosity rendering enabled
  • BORDER_RENDER: Small cut-out rendering enabled
  • PANORAMA: Panorama rendering enabled
  • CROP: Crop image during border renders
  • ODDFIELD: Odd field first rendering enabled
  • MBLUR: Motion blur enabled
  • UNIFIED: Unified Renderer enabled
  • RAYTRACING: Ray tracing enabled
  • THREADS: Render in two threads enabled (Deprecated, use RenderData.threads)
Type:
readonly dictionary

NONE

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

NTSC

Output format. Use with renderdata.sizePreset()

OPENEXR

Output format. Use with renderdata.imageType / setImageType()

PAL

Output format. Use with renderdata.sizePreset()

PAL169

Output format. Use with renderdata.sizePreset()

PC

Output format. Use with renderdata.sizePreset()

PNG

Output format. Use with renderdata.imageType / setImageType()

PREVIEW

Output format. Use with renderdata.sizePreset()

QUICKTIME

Output format. Use with renderdata.imageType / setImageType()

RAWTGA

Output format. Use with renderdata.imageType / setImageType()

SceModes

Constant dict used for with RenderData.sceneMode bitfield attribute. Values can be ORed together. Individual bits can also be set/cleared with boolean attributes.
  • SEQUENCER: Enables sequencer output rendering.
  • EXTENSION: Adds extensions to the output when rendering animations.
  • SAVE_BUFFERS: Save render tiles to disk to save memory.
  • FREE_IMAGES: Free images used by textures after each render.
Type:
readonly dictionary

SKYDOME

Yafray GI Quality. Use with renderdata.setYafrayGIQuality()

TARGA

Output format. Use with renderdata.imageType / setImageType()

TIFF

Output format. Use with renderdata.imageType / setImageType()

YAFRAY

Yafray rendering engine. Use with setRenderer()

   Home       Trees       Index       Help   

Blender

Generated by Epydoc 2.1 on Sun Feb 11 13:30:19 2007 http://epydoc.sf.net