=== Blender Python API ===
[blender.git] / source / blender / python / api2_2x / doc / Renderlayer.py
1 # Blender.Scene.Render.RenderLayer module and the RenderLayer PyType object
2
3 """
4 The Blender.Scene.Render.RenderLayer submodule.
5
6 Scene.Render.RenderLayer
7 ========================
8
9 This module provides access to B{Render Layers} in Blender.
10
11 Example::
12         import bpy
13         sce = bpy.data.scenes.active
14         render = sce.render
15         layer = render.addRenderLayer()
16         render.removeRenderLayer(layer)
17 """
18
19 class RenderLayer:
20         """
21         The RenderLayer object
22         ======================
23         @type name: string
24         @ivar name: Get or set the name for the L{RenderLayer}
25         @type lightGroup: group
26         @ivar lightGroup: group of lights
27         @type enable: bool
28         @ivar enable: enable this render layer
29         @type enableZMask: bool
30         @ivar enableZMask: Only render what's in front of the solid z values
31         @type enableZMaskAll: bool
32         @ivar enableZMaskAll: Fill in Z values for solid faces in invisible layers, for masking
33         @type enableSolid: bool
34         @ivar enableSolid: Render Solid faces in this Layer
35         @type enableZTra: bool
36         @ivar enableZTra: Render Z-Transparent faces in this Layer (On top of Solid and Halos)
37         @type enableHalo: bool
38         @ivar enableHalo: Render Halos in this Layer (on top of Solid)
39         @type enableEdge: bool
40         @ivar enableEdge: Render Edge-enhance in this Layer (only works for Solid faces)
41         @type enableSky: bool
42         @ivar enableSky: Render Sky or backbuffer in this Layer
43         @type enableStrand: bool
44         @ivar enableStrand: Render Strands in this Layer
45         @type layerMask: bool
46         @ivar layerMask: ...
47         @type zLayerMask: bool
48         @ivar zLayerMask: ...
49           
50         @type passCombined: bool
51         @ivar passCombined: Deliver full combined RGBA buffer
52         @type passZ: bool
53         @ivar passZ: Deliver Z values pass
54         @type passSpeed: bool
55         @ivar passSpeed: Deliver Speed Vector pass
56         @type passNormal: bool
57         @ivar passNormal: Deliver Normal pass
58         @type passUV: bool
59         @ivar passUV: Deliver Texture UV pass
60         @type passMist: bool
61         @ivar passMist: Deliver Mist factor pass (0-1)
62         @type passIndex: bool
63         @ivar passIndex: Deliver Object Index pass
64         @type passColor: bool
65         @ivar passColor: Deliver shade-less Color pass
66         @type passDiffuse: bool
67         @ivar passDiffuse: Deliver Diffuse pass
68         @type passSpecular: bool
69         @ivar passSpecular: Deliver Specular pass
70         @type passShadow: bool
71         @ivar passShadow: Deliver Shadow pass
72         @type passAO: bool
73         @ivar passAO: Deliver AO pass
74         @type passReflect: bool
75         @ivar passReflect: Deliver Raytraced Reflection pass
76         @type passRefract: bool
77         @ivar passRefract: Deliver Raytraced Reflection pass
78         @type passRadiosity: bool
79         @ivar passRadiosity: Deliver Radiosity pass
80         
81         
82         @type passSpecularXOR: bool
83         @ivar passSpecularXOR: Deliver Specular pass XOR
84         @type passShadowXOR: bool
85         @ivar passShadowXOR: Deliver Shadow pass XOR
86         @type passAOXOR: bool
87         @ivar passAOXOR: Deliver AO pass XOR
88         @type passRefractXOR: bool
89         @ivar passRefractXOR: Deliver Raytraced Reflection pass XOR
90         @type passRadiosityXOR: bool
91         @ivar passRadiosityXOR: Deliver Radiosity pass XOR
92         """