~ubuntu-branches/ubuntu/gutsy/blender/gutsy-security

« back to all changes in this revision

Viewing changes to source/blender/python/api2_2x/doc/Render.py

  • Committer: Bazaar Package Importer
  • Author(s): Florian Ernst
  • Date: 2005-11-06 12:40:03 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051106124003-3pgs7tcg5rox96xg
Tags: 2.37a-1.1
* Non-maintainer upload.
* Split out parts of 01_SConstruct_debian.dpatch again: root_build_dir
  really needs to get adjusted before the clean target runs - closes: #333958,
  see #288882 for reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
"""
4
4
The Blender.Scene.Render submodule.
5
5
 
6
 
Scene
7
 
=====
 
6
Scene.Render
 
7
============
8
8
 
9
9
This module provides access to B{Scene Rendering Contexts} in Blender.
10
10
 
11
11
Example::
12
12
  import Blender
13
 
  from Blender import Scene
14
 
  from Blender import Scene.Render
 
13
  from Blender import *
 
14
  from Blender.Scene import Render
15
15
  
16
16
  scn = Scene.GetCurrent()
17
17
  context = scn.getRenderingContext()
18
18
  
19
 
  Render..enableDispWin()
 
19
  Render.EnableDispWin()
20
20
  context.enableExtensions(1)
21
21
  context.setRenderPath("C:/myRenderdir/")
22
22
  context.sizePreset(Scene.PC)
29
29
  context.framesPerSec(15)
30
30
  context.startFrame(15)
31
31
  context.endFrame(22)
32
 
 context.renderAnim()
 
32
  context.renderAnim()
33
33
 
34
34
  Render.CloseRenderWindow()
35
35
  print context.framesPerSec()
87
87
  =====================
88
88
    This object gives access to Scene rendering contexts in Blender.
89
89
  """
90
 
  
91
 
  def getRenderdir():
92
 
    """
93
 
    @warn: B{Depricated}: use RenderData.getRenderPath()
94
 
    """
95
 
 
96
 
  def getBackbufdir():
97
 
    """
98
 
    @warn: B{Depricated}: use RenderData.getBackbufPath()
99
 
    """
100
 
 
101
 
  def getChildren():
102
 
    """
103
 
    Get all objects linked to this Scene.
104
 
    @rtype: list of Blender Objects
105
 
    @return: A list with all Blender Objects linked to this Scene.
106
 
    """
107
 
 
108
 
  def getCurrentCamera():
109
 
    """
110
 
    Get the currently active Camera for this Scene.
111
 
    @rtype: Blender Camera
112
 
    @return: The currently active Camera.
113
 
    """
114
 
 
115
 
  def setCurrentCamera(camera):
116
 
    """
117
 
    Set the currently active Camera in this Scene.
118
 
    @type camera: Blender Camera
119
 
    @param camera: The new active Camera.
120
 
    """
121
 
 
 
90
 
122
91
  def render():
123
92
    """
124
93
    Render the scene.
134
103
    play animation of rendered images/avi (searches Pics: field).
135
104
    """
136
105
 
 
106
  def getTimeCode():
 
107
    """
 
108
    Get the current frame as a string in HH:MM:SS:FF format
 
109
    @rtype: string 
 
110
    @return: current frame as a string in HH:MM:SS:FF format
 
111
    """
 
112
 
137
113
  def setRenderPath(path):
138
114
    """
139
115
    Set the path to where the renderer will write to.
389
365
    @param toggle: pass 1 for on / 0 for off
390
366
    """
391
367
 
 
368
  def setBorder(left,bottom,right,top):
 
369
    """
 
370
    Set a border for rendering from cameras in the scene.
 
371
    The left,bottom coordinates and right,top coordinates
 
372
    define the size of the border. (0,0,1,1) will set the border
 
373
    to the whole camera. (0,0) lower left and (1,1) upper right.
 
374
    @type left: float
 
375
    @param left: float between 0 and 1
 
376
    @type right: float
 
377
    @param right: float between 0 and 1
 
378
    @type bottom: float
 
379
    @param bottom: float between 0 and 1
 
380
    @type top: float
 
381
    @param top: float between 0 and 1
 
382
    """
 
383
 
392
384
  def enableGammaCorrection(toggle):
393
385
    """
394
386
    Enable/disable gamma correction.
851
843
    @param value: must be between 1 - 900
852
844
    @rtype: int (if prototype is empty)
853
845
    @return: Current new map value for the scene.
854
 
    """
 
 
b'\\ No newline at end of file'
 
846
    """