Scene file format 0.9 - LuxRender Wiki
Luxrender GPL Physically Based Renderer

Scene file format 0.9

Personal tools

From LuxRender Wiki

Jump to: navigation, search


Contents

A Word on Colors and Gamma

In LuxRender, colors are always described as linear RGB floats. For example, [0.80000001 0.80000001 0.80000001]

Some 3D applications will give a linear RGB float color when queried for the value of a color, but others may not. If they do give a linear RGB float triplet, you can simply write it to the scene file as-is, your app and LuxRender "speak the same language" for colors. However, this may not be the case. You might instead receive a 8bit integer triplet, such as [255, 255, 255]. This can be converted to the equivalent float by dividing by 255.

However, this might not give the color the user thought they were inputting. Some applications will return color queries with a value that already has gamma correction applied. Returning integer colors and gamma corrected colors often goes hand-in-hand. If an app returns a float, there is a good chance it is linear gamma. If it returns an integer, it is probably NOT linear gamma. Neither is guaranteed, however, and you should check any relevant api documentation for the application you are working with. If your application returns values with gamma correction applied to them, you should apply reverse gamma correction prior to writing them to scene file, in order to ensure that linear values are written out.

As a physically based renderer, linear workflow is fairly important for LuxRender, and is strongly enforced. All color inputs are assumed to be linear. Image textures are assumed to not be linear and have reverse gamma correction applied to them (the gamma parameter on the image map texture sets this, it should be set to the gamma the texture was created in for color textures, but left at 1.0 for float textures). The film is saved in linear XYZ color space, and gamma corrected for viewport display or when saving PNG or TGA output (this is done according the film gamma setting). The OpenEXR output is NOT gamma corrected, as the OpenEXR spec states that these files should always be linear gamma. The write_exr_applyimaging flag does NOT affect this behavior, it causes everything except gamma correction and clamping to be applied.

Light

General Syntax:

LightSource TYPE <parameters>

Where TYPE in one of the following:

  • area
  • distant
  • goniometric
  • infinite
  • point
  • projection
  • sky
  • spot
  • sun

There is no default type.

For convenience, it's possible to specify the sunsky light which automatically creates a sun and sky light with the same parameters.

Examples

Here are some examples of light declarations:

Type Code
Point Texture "pL" "color" "blackbody" "float temperature" [6500.0]
LightSource "point" "texture L" ["pL"] "float gain" [1.0]
Spot Texture "Spots::L" "color" "blackbody" "float temperature" [3200.00]
LightSource "spot" "point from" [0 0 0] "point to" [0 0 -1] "float coneangle" [70] "float conedeltaangle" [5]
   "texture L" ["Spots::L"] "float gain" [1.50]

Common Light Parameters

These parameters are applicable to all light plugins:

name type description default value
importance float It is part of the Rendering Hints framework. It is a user defined value > 0.0. It can be used by a light strategy as weight for choosing which light source to sample more (available since v0.7). 1.0

Specific Light Parameters

These parameters are specific to individual light plugins:

name type description default value
area::L color The color of the light. 1 1 1
area::nsamples integer The suggested number of shadow samples when computing illumination from the given light. 1
distant::L color The color of the light. 1 1 1
distant::from/to point The two points defining the light direction. Default is down the z axis. 0 0 0 and 0 0 1
goniometric::I color The color of the light 1 1 1
goniometric::mapname string The filename of the goniometric file (goniometric diagram of light distribution) no default
infinite::L color The color of the light. 1 1 1
infinite::nsamples integer The suggested number of shadow samples when computing illumination from the given light. 1
infinite::mapname string The filename of the environment map for an infinite area light. If not provided, a solid color is used. no default
point::I color The color of the light. 1 1 1
point::from point The location of the point light. 0 0 0
projection::I color The color of the light. 1 1 1
projection::fov float The field of view in terms of angular spread along the shorter image axis. 45
projection::mapname string The filename of the image to project. required - no default
sky::gain float Gain (aka scale) factor to apply to sun/skylight. 0.005
sky::nsamples integer The suggested number of shadow samples when computing illumination from the given light. 1
sky::sundir vector Direction vector of the sun. 0 0 1
sky::turbidity float Turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days. 2.0
sky::aconst/bconst/cconst/dconst/econst float Perez function multiplicative constants. 1.0
spot::I color, texture The color of the light. 1 1 1
spot::from/to point Points defining the axis of the spot light. Default is down the z-axis. 0 0 0 and 0 0 1 respectively.
spot::coneangle float The angle in degrees of the spotlight cone. 30
spot::conedeltaangle float The angle at which the spotlight intensity starts to fade from the edge. 5
spot::gain float The intensity of the spot light  
sun::gain float Gain (aka scale) factor to apply to sun/skylight. 0.005
sun::nsamples integer The suggested number of shadow samples when computing illumination from the given light. 1
sun::sundir vector Direction vector of the sun. 0 0 -1
sun::turbidity float Turbidity can go from 1.0 to 30+. 2-6 are most useful for clear days. 2.0
sun::relsize float Relative size to the sun. 1.0

Shape

Here are the shape types. Each one is a separate plugin.

  • cone
  • cylinder
  • disk
  • heightfield
  • hyperboloid
  • lenscomponent
  • loopsubdiv
  • nurbs
  • paraboloid
  • plymesh
  • stlmesh
  • sphere
  • trianglemesh
  • mesh

Common Shape Parameters

name type description default value
name string A string for identifying the mesh to the user. The contents of this string are not used by the renderer, names can be repeated or used arbitrarily. It is solely for human-readable output ""

Common Mesh Shape Parameters

The following parameters are shared among the mesh shapes, mesh, trianglemesh, plymesh, and stlmesh

name type description default value
generatetangents bool Generate tangent space using miktspace, useful if mesh has a normal map that was also baked using miktspace (such as blender or xnormal) false
subdivscheme string Subdivision algorithm, options are "loop" and "microdisplacement" "loop"
displacementmap string Name of the texture used for the displacement. Subdivscheme parameter must always be provided, as load-time displacement is handled by the loop-subdivision code. none - optional. (loop subdiv can be used without displacement, microdisplacement will not affect the mesh without a displacement map specified)
dmscale float Scale of the displacement (for an LDR map, this is the maximum height of the displacement in meter) 0.1
dmoffset float Offset of the displacement. 0
dmnormalsmooth bool Smoothing of the normals of the subdivided faces. Only valid for loop subdivision. true
dmnormalsplit bool Force the mesh to split along breaks in the normal. If a mesh has no normals (flat-shaded) it will rip open on all edges. Only valid for loop subdivision. false
dmsharpboundary bool Try to preserve mesh boundaries during subdivision. Only valid for loop subdivision. false
nsubdivlevels integer Number of subdivision levels. This is only recursive for loop subdivision, microdisplacement will need much larger values (such as 50). 0


Specific Shape Parameters

These parameters are specific to individual shape plugins.

Cone

name type description default value
cone::radius float The radius of the cone. 1.0
cone::radius2 float The radius of the cone upper face in case of a cone frustum (available since v0.7). 0.0
cone::height float The height of the cone - along the z axis 1.0
cone::phimax float The angle (degrees) swept out by the cone round its circular base 360.0

Cylinder

name type description default value
cylinder::radius float The radius of the cylinder 1.0
cylinder::zmin float The position of the bottom of the cylinder along the z axis -1.0
cylinder::zmax float The position of the top of the cylinder along the z axis 1.0
cylinder::phimax float The angle (in degrees) swept out by the cylinder 360.0

Disk

name type description default value
disk::height float The location of the disk (which is flat) along the z-axis 0.0
disk::radius float The radius to the outer rim of the disk 1.0
disk::innerradius float The radius to the inner rim of the disk - defines a "hole" in the disk 0.0
disk::phimax float The angle (degrees) swept out by the disk 360.0

Height Field

name type description default value
heightfield::nu integer Number of points in the u axis none - must be specified
heightfield::nv integer Number of points in the v axis none - must be specified
heightfield::Pz float[nu*nv] The height of each point in the grid none - must be specified

Hyperboloid

name type description default value
hyperboloid::p1 point The hyperboloid lies between p1 and p2. Here p1 defines the start of the hyperboloid 0 0 0
hyperboloid::p2 point The hyperboloid lies between p1 and p2. Here p2 defines the end of the hyperboloid 0 0 0
hyperboloid::phi float The angle (in degrees) swept out by the hyperboloid 360.0

Subdivision Surfaces

Deprecated, instead use subdivscheme parameter on trianglemesh/mesh/plymesh/stlmesh shapes as applicable. This will allow for microdisplacement support.

name type description default value
loopsubdiv::nlevels integer The level of subdivision applied to the base mesh 3
loopsubdiv::indices integer[n] Indices of the cage mesh - using the same format as used in the triangle primitive none - must be specified
loopsubdiv::P point[n] Vertex positions of the cage mesh - using the same format as used in the triangle primitive none - must be specified
loopsubdiv::uv float[2*n] Vertex texture coordinates of the cage mesh - using the same format as used in the triangle primitive none - optional
loopsubdiv::displacementmap string The name of a float texture to use as displacement map none - optional
loopsubdiv::dmscale float Scale the output of displacement map by the specified value (use negative value in order to invert the map) 0.1
loopsubdiv::dmoffset float Translate the output of displacement map by the specified value 0.0
loopsubdiv::dmnormalsmooth bool Interpolate normals in order to get a smooth output true
loopsubdiv::dmsharpboundary bool The output mesh will have the same boundary of the cage mesh if this flag is true, otherwise the boundary will be interpolated as well false

Lens Component

This shape is primarily used by the realistic camera. Lens are approximated by a sphere section.

name type description default value
lenscomponent::radius float The radius of the sphere 1.0
lenscomponent::zmin float The position of the bottom of the sphere along the z axis -radius
lenscomponent::zmax float The position of the top of the sphere along the z axis radius
lenscomponent::phimax float The angle (in degrees) swept out by the sphere 360.0
lenscomponent::aperture float The aperture of the lens 1.0

NURBS

name type description default value
nurbs::nu integer Sets the number of control points in the u direction none - must be specified
nurbs::nv integer Sets the number of control points in the v direction none - must be specified
nurbs::uorder integer The order (surface degree + 1) in the u direction Defines how many nearby control points affect each control point none - must be specified
nurbs::vorder integer The order (surface degree + 1) in the v direction. Defines how many nearby control points affect each control point none - must be specified
nurbs::uknots float[nu+uorder] (eg. if nu = 2 and uorder = 2 we have a float[4] such as (1,1,1,1)) The knot vector in the u direction none - must be specified
nurbs::vknots float[nv+vorder] The knot vector in the v direction none - must be specified
nurbs::u0/nurbs::v0 float The u and v coordinates from which NURB surface evaluation starts uknots[uorder-1]/vknots[vorder-1]
nurbs::u1/nurbs::v1 float The u and v coordinates from which NURB surface evaluation ends uknots[nu]/vknots[nv]
nurbs::P point[nu*nv] P specifies regular control points on the NURBS surface none - one of either P or Pw must be specified
nurbs::Pw float[4*nu*nv] Pw specifies rational control points on the surface which include a weight value for each control point none - one of either P or Pw must be specified

Paraboloid

name type description default value
paraboloid::radius float The radius of the paraboloid 1.0
paraboloid::zmin float The position of the bottom the paraboloid along the z axis 0.0
paraboloid::zmax float The position of the top the paraboloid along the z axis 1.0
paraboloid::phimax float The angle (in degrees) swept out by the paraboloid 360.0

PLY Mesh Loader

name type description default value
plymesh::filename string The .ply filename to load none
plymesh::smooth bool Toggles smoothing of the mesh faces false

Plymesh example:

AttributeBegin # Plymodel
     NamedMaterial "plymodel"
     Shape "plymesh"
     "string filename" ["c:\\blender\\models\\plymesh.ply"]
AttributeEnd

STL Mesh Loader

Same as plymesh, but loads STL files instead.

name type description default value
stlmesh::filename string The .ply filename to load none
stlmesh::smooth bool Toggles smoothing of the mesh faces false

Sphere

name type description default value
sphere::radius float The radius of the sphere 1.0
sphere::zmin float The position of the bottom of the sphere along the z axis Set to - sphere::radius
sphere::zmax float The position of the top of the sphere along the z axis Set to - sphere::radius
sphere::phimax float The angle (in degrees) swept out by the sphere 360.0

Triangle Mesh

There are two types of triangle mesh: barytrianglemesh and waldtrianglemesh. Both have the same below parameters but waldtrianglemesh uses a better intersection algorithm. Using only trianglemesh defaults to the barytrianglemesh which is better tested.

name type description default value
trianglemesh::indices integer[n] An array indexing the triangles found in the P array. The three vertices of the ith triangle are given by 3i, 3i+1, 3i+2. This provides the ordering of the triangles none - must be specified
trianglemesh::P point[n] An unordered list of vertex positions in the triangle mesh. Ordered with trianglemesh::indices none - must be specified
trianglemesh::N normal[n] Per vertex normals over the triangle mesh none - optional
trianglemesh::S vector[n] Tangents given at each vertex. Tangents are perpendicular to normals none - optional (deprecated)
trianglemesh::uv float[2*n] Texture coordinates (per vertex) none - optional
trianglemesh::st float[2*n] Texture coordinates (per vertex) none - optional

Mesh

Available since v0.6.

name type description default value
mesh::N normal[n] Per vertex normals over the mesh none - optional
mesh::P point[n] An unordered list of vertex positions in the mesh. none - must be specified
mesh::acceltype string Accelerator structure to use (auto, bruteforce, grid, kdtree, none, qbvh) "auto"
mesh::quadindices integer[4*q] An array indexing the quadrilaterals found in the P array. The three vertices of the ith quadrilateral are given by 4i, 4i+1, 4i+2, 4i+3. This provides the ordering of the quadrilaterals none - must be specified
mesh::quadtype string Select the intersection routine used for quadrilaterals (quadrilateral) "quadrilateral"
mesh::triindices integer[3*t] An array indexing the triangles found in the P array. The three vertices of the ith triangle are given by 3i, 3i+1, 3i+2. This provides the ordering of the triangles none - must be specified
mesh::tritype string Select the intersection routine used for triangles (auto, bary, wald) "auto"
mesh::uv float[2*n] Texture coordinates (per vertex) none - optional

Volume

These volume types are deprecated! Instead you should use normal shapes with Interior/Exterior defined

Here are the volume types. There is not default type.

  • exponential
  • homogenous
  • volumegrid

Common Volume Parameters

Here are the common parameters for volumes.

name type description default value
sigma_a colour The absorption cross section. 0
sigma_s colour The scattering cross section. 0
g float The phase function asymmetry parameter. 0
Le colour The volume's emission spectrum. 0
p0 point One corner of the bounding box defining the volume calculations. 0 0 0
p1 point The second corner of the bounding box defining the volume calculations. 1 1 1

Specific Volume Parameters

These parameters are specific to individual volume plugins:

name type description default value
exponential::a/b float exponential::a and exponential::b are the parameters in the ae^{-bh} formula 1
exponential::updir vector The "up" direction along which to compute height. (0,1,0)
volumegrid::nx/ny/nz integer Each of these parameters denote the number of voxels in the x,y and z directions respectively. 1
volumegrid::density float[nx*ny*nz] The array of density values. 0

Material

Here are the material types.

  • carpaint
  • glass
  • glass2
  • glossy
  • glossytranslucent
  • glossy_lossy (deprecated)
  • matte (default)
  • mattetranslucent
  • metal
  • metal2
  • mirror
  • mix
  • null
  • roughglass
  • shinymetal
  • scatter
  • velvet

Glossy_lossy is deprecated and should not be used. Glossy should be used instead.

Common Material Parameters

Here are the common parameters for materials. Note that float and color textures are described in the 'Texture' section.

name type description default value
bumpmap float texture The floating-point texture for use as a bump map None

Integrator Dependant Parameters

The following material parameters are available on all materials for the stated Integrators:

name type integrator description default value
compo_visible_material bool distributedpath XXX true
compo_visible_emission bool distributedpath XXX true
compo_visible_indirect_material bool distributedpath XXX true
compo_visible_indirect_emission bool distributedpath XXX true
compo_override_alpha bool distributedpath Override the alpha value in the output image for hits on this material false
compo_override_alpha_value float distributedpath Value to set alpha to when overridden 0.0

Specific Material Parameters

These parameters are specific to individual material plugins.

Car Paint

The available names for the carpaint material are:

  • "ford f8"
  • "polaris silber"
  • "opel titan"
  • "bmw339"
  • "2k acrylack"
  • "white"
  • "blue"
  • "blue matte"

Other parameters are only necessary if no name given.

name type description default value
carpaint::name string The name of the car paint model to use "ford f8"
carpaint::Kd spectrum texture Diffuse component "ford f8" data
carpaint::Ks1 / carpaint::Ks2 / carpaint::Ks3 spectrum texture Specular component of layers "ford f8" data
carpaint::R1 / carpaint::R2 / carpaint::R3 float texture Fresnel constants of layers "ford f8" data
carpaint::M1 / carpaint::M2 / carpaint::M3 float texture Microfacet roughness of layers "ford f8" data

Glass

name type description default value
glass::Kr color, texture The reflectivity of the surface [1.0 1.0 1.0]
glass::Kt color, texture Fraction of light transmitted through the surface [1.0 1.0 1.0]
glass::index float, texture The index of refraction for the glass surface 1.5
glass::cauchyb float, texture Cauchy B coefficient 0.0
glass::film float, texture The thickness in nanometers of the thin film coating (0.0 disables) on the surface 0.0
glass::filmindex float, texture The index of refraction of the thin film coating on the surface 1.5
glass::architectural bool Disables refraction during transmission, improves rendering speed with thin sheets False

Glass2

Glass2 is an "empty shell" for volumes, it will be invisible if no interior medium is specified

name type description default value
glass2::architectural bool Disables refraction during transmission, improves rendering speed with thin sheets False
glasss2::dispersion bool Enables chromatic dispersion. Should be used with a volume that has a fresnel texture other than "constant" False

Glossy

name type description default value
glossy::Kd color texture The coefficient of diffuse reflection 0.5
glossy::Ks color texture The coefficient of specular reflection 0.5
glossy::Ka color texture The coefficient of absorption of the coating layer 0.0
glossy::uroughness float texture The roughness of the surface in the u direction 0.1
glossy::vroughness float texture The roughness of the surface in the v direction 0.1
glossy::d float texture The depth (thickness) of the coating layer for absorption effects. (0 = disables) 0.0
glossy::index float texture IOR of the coating. 0.0
glossy::multibounce bool Simulation of asperity (velvet-like) on the glossy surface false

GlossyTranslucent

name type description default value
glossytranslucent::Kd color texture The coefficient of diffuse reflection 0.5
glossytranslucent::Ks color texture The coefficient of specular reflection 0.5
glossytranslucent::Kt color texture The coefficient of transmission 1.0
glossytranslucent::Ka color texture The coefficient of absorption of the coating layer 0.0
glossytranslucent::uroughness float texture The roughness of the surface in the u direction 0.1
glossytranslucent::vroughness float texture The roughness of the surface in the v direction 0.1
glossytranslucent::d float texture The depth (thickness) of the coating layer for absorption effects. (0 = disables) 0.0
glossytranslucent::index float texture IOR of the coating. 0.0
glossytranslucent::onesided bool Disable seperate coating for backface True
glossytranslucent::backface_Ks color texture The coefficient of backface specular reflection 0.5
glossytranslucent::backface_Ka color texture The coefficient of absorption of the backface coating layer 0.0
glossytranslucent::backface_uroughness float texture The roughness of the backface surface in the u direction 0.1
glossytranslucent::backface_vroughness float texture The roughness of the backface surface in the v direction 0.1
glossytranslucent::backface_d float texture The depth (thickness) of the coating layer for backface absorption effects. (0 = disables) 0.0
glossytranslucent::backface_index float texture IOR of the backface coating. 0.0

Matte

name type description default value
matte::Kd color texture The diffuse reflectivity of the surface 1.0
matte::sigma float texture The sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection 0.0

MatteTranslucent

name type description default value
mattetranslucent::Kr color texture The diffuse reflectivity of the surface 1.0
mattetranslucent::Kt color texture The diffuse transmitivity of the surface 1.0
mattetranslucent::sigma float texture The sigma parameter in the Oren-Nayer shader in degrees. Zero for pure Lambertian reflection 0.0
mattetranslucent::energyconserving bool Enabling forces energy conservation by making Kt = Kt*(1-Kr) (the glossytranslucent material does not have a similar flag, it acts as though it was always enabled) False

Metal

These are the possible inbuilt metal names:

  • "amorphous carbon"
  • "silver"
  • "gold"
  • "copper"
  • "aluminium"
name type description default value
metal::name string The name of the desired inbuilt metal or nkdata file. 1.0
metal::uroughness float texture Roughness of the surface in the u direction from 0 to 1. Rough surfaces have blurry highlights 0.001
metal::vroughness float texture Roughness of the surface in the v direction from 0 to 1. Rough surfaces have blurry highlights 0.001

Metal2

Note that "fresnel" is a fresnel texture input, not a float, even though the command for a constant value is "float fresnel".

name type description default value
metal2::fresnel fresnel texture Fresnel input for the metal's nk profile. Can accept constant values, but is meant primarily to be used with the fresnelcolor (constant color) and fresnelname (presets/measured data) textures. 5.0
metal2::uroughness float texture Roughness of the surface in the u direction from 0 to 1. Rough surfaces have blurry highlights 0.001
metal2::vroughness float texture Roughness of the surface in the v direction from 0 to 1. Rough surfaces have blurry highlights 0.001

Mirror

name type description default value
mirror::Kr color texture The reflectivity of the mirror 1.0
glass::film float texture The thickness in nanometers of the thin film coating (0.0 disables) on the surface 0.0
glass::filmindex float texture The index of refraction of the thin film coating on the surface 1.5

Mix

name type description default value
mix::namedmaterial1 string The name of the first material to mix None
mix::namedmaterial1 string The name of the second material to mix None
mix::amount float texture The value or texture to mix by 0.5

Null

The Null material takes no options.

Rough Glass

name type description default value
roughglass::Kr color texture The reflectivity of the surface 1.0
roughglass::Kt color texture Fraction of light transmitted through the surface 1.0
roughglass::uroughness float texture Roughness of the surface in the u direction from 0 to 1. Rough surfaces have blurry highlights 0.001
roughglass::vroughness float texture Roughness of the surface in the v direction from 0 to 1. Rough surfaces have blurry highlights 0.001
roughglass::index float texture The index of refraction for the glass surface 1.5
roughglass::cauchyb float texture Cauchy B coefficient 0.0

Shiny Metal

name type description default value
shinymetal::uroughness float texture Roughness of the surface in the u direction from 0 to 1. Rough surfaces have blurry highlights 0.001
shinymetal::vroughness float texture Roughness of the surface in the v direction from 0 to 1. Rough surfaces have blurry highlights 0.001
shinymetal::Ks color texture The coefficient of glossy reflection 1.0
shinymetal::Kr color texture The coefficient of specular reflection 1.0
shinymetal::film float texture The thickness in nanometers of the thin film coating (0.0 disables) on the surface 0.0
shinymetal::filmindex float texture The index of refraction of the thin film coating on the surface 1.5

Scatter

name type description default value
scatter::Kd color texture Color of the material 1.0
scatter:g float texture Value from -1 to 1.0 that sets the asymmetry of the scattering 0.0

Velvet

name type description default value
velvet::Kd color texture Color of the material's fuzz 1.0
velvet:thickness float texture Height of the fuzz 0.10
velvet:p1 float texture Polynomial that influences the fuzz -2.0
velvet:p2 float texture Polynomial that influences the fuzz 20.0
velvet:p3 float texture Polynomial that influences the fuzz 2.0

Texture

General Syntax

	Texture NAME color|float|spectrum|fresnel TYPE <values>

Where NAME is a quoted string, and TYPE is one of the types listed below. The second parameter for a texture denotes if this texture defines values of type color, float or spectrum.

Textures are declared differently from what we have seen so far. An example of a texture declaration is:

	Texture "checks" "color" "checkerboard"

'checks' is the name given by the user to the texture. This name is arbitrarily chosen by the user to refer to in the material declaration. In order to tell a "matte" material to use a checkerboard texture for diffuse reflectivity, in this example you would type:

	Material "matte" "texture Kd" "checks"

Again, note that you refer to a texture, you type "texture param" "name" where param is the parameter you want the texture to modulate and name is the name you have assigned the texture. color refers to the texture type which can be "color" or "float". Note the US English spelling of the word.

Texture Types

There is no default texture type. The texture types are:

Type Variants Description
band float/color/fresnel "Gradient" texture. This is a more sophisticated version of the mix texture that allows more than 2 values.
bilerp float/color/fresnel  !TBD
blackbody color Definition of the color temperature expressed in Kelvin. For example:
Texture "LampTemp" "color" "blackbody" "float temperature" [6500]
brick float/color Procedural pattern for generating bricks and tile
cauchy fresnel Allows defining of fresnel inputs via Cauchy's equation
checkerboard float/color A checkerboard. Useful to visualize the geometry flow.
colordepth color A texture for simplifying absorption. Takes a target color and the depth that light should penetrate before becoming that color. This is a curve, light that penetrates shorter distances will be lighter and less saturated, and vice versa
constant float/color/fresnel A constant value for a color, expressed in [r g b], for example:
Texture "SolidColor" "color" "constant" "color value" [1.000 0.910 0.518]
dots color TBD
fbm float A fractal brownian motion pattern
fresnelcolor fresnel A color > nk converter. Takes an input color and outputs an IOR distribution so that a reflective object reflects the input color. (primarily used for metal2 material)
fresnelname fresnel IOR data loader. Can load an NK file in the Sopra or Luxpop formats, or one of several presets. (this should be used in place of the luxpop or sopra textures)
gaussian color Defines a spectrum along a gaussian curve
harlequin color Geometry test pattern. Colors each face differently
imagemap float/color A texture defined with an external image.
lampspectrum color A loader of spectral presets for various light sources.
luxpop fresnel A Luxpop NK file loader. Deprecated in 0.9, use fresnelname instead.
marble color Procedural marble.
mix float/color/fresnel A mix of two textures based on a third value that can be either a constant or bitmap-based. Useful to combine textures or define transparency maps.
multimix float/color/fresnel A textures for adding other textures. Each input texture is scaled by its "weight" value, then the results are summed. (thus, this is also the add/subtract node.)
normalmap float A special version of imagemap for loading normal maps.
scale float/color/fresnel Multiplies the two input values/textures. This is the multiply/divide node for the texture pipeline.
sellmeier fresnel Allows defining of fresnel inputs via the Sellmeier equation
sopra fresnel A Sopra NK file loader. Deprecated in 0.9, use fresnelname instead.
tabulateddata color Loads external datafile that defines color across a spectrum
uv color A UV test pattern
uvmask TBD TBD
windy float A fractal pattern for waves on water surfaces. It has no parameters.
wrinkled float A procedural noise texture, good for producing wrinkling or clouding on surfaces.
blender_clouds float Blender's clouds procedural noise. Has various Perlin/Voronoi clouds patterns.
blender_distortednoise float Blender's distorted noise texture. Distorts one noise pattern by another.
blender_musgrave float Blender's Musgrave procedural noise.
blender_noise float Blender's noise texture. Produces a fine, high-frequency noise.
blender_magic float Blender's "magic" texture. Produces a sort of layered cross-hatch pattern
blender_marble float Blender's "marble" texture. Produces bands of noise
blender_stucci float Blender's Stucci procedural noise
blender_voronoi float Blender's Voronoi procedural noise
blender_wood float Blender's "wood" texture.

Common Texture Parameters (2D)

Only 2D textures share these parameters: these are 'bilerp','imagemap','uv','checkerboard' and 'dots'. Note that checkerboard can also be a 3D texture and that u,v coordinates are used.

name type description default value
mapping string Texture mapping to use. Can be "uv", "spherical","cylindrical" or "planar". "uv"
uscale/vscale float The scaling of the u/v texture coordinates. Only applies to "uv" mapping. 1
udelta/vdelta float u/v offset for "planar" or "uv" texture mappings. 1
v1/v2 vector The two vectors that define the plane for "planar" mapping (1,0,0) and (0,1,0) respectively

Common Texture Paramaters (3D)

name type description default value
coordinates string Coordinate system for 3D texture space. Options are "global", "local" "global normal", "objectnormal" and "uv" "global"
translate vector Translate transformation for 3D texture space 0 0 0
rotate vector Rotate transformation for 3D texture space 0 0 0
scale vector Scale transformation for 3D texture space 1 1 1

Specific Texture Parameters

These parameters are specific to individual texture plugins:


Texture: bilerp

name type description default value
bilerp::v00/v01/v10/v11 color/float/fresnel Four values to bilinearly interpolate between. 0,1,0 and 1 respectively

Texture: checkerboard

name type description default value
checkerboard::dimension integer Specifies whether a 2D or 3D checkerboard texture is being used. Values can be either 2 or 3. Defaults to 2.
checkerboard::tex1/tex2 color/float texture The texture to use for even/odd squares of the checkerboard. 1 and 0 respectively
checkerboard::aamode color/float texture For 2D checkerboard only - the antialiasing mode to use: "closedform","supersample" or "none". "closedform"

Texture: brick

name type description default value
brick::brickbond string Determines the brick pattern. One of: "stacked", "flemish", "english", "herringbone", "basket", "chain link". "stacked"
brick::width float width of the brick. 0.3
brick::height float Height of the brick 0.1
brick::depth float Depth of the brick 0.15
brick::mortarsize float Size of the mortar strips 0.01
brick::bevel float Bevel for the brick 0.0
brick::brickrun float Amount of linear offset down the row between adjacent rows. It works only for stacked, english, and flemish. For correct result with flemish brickrun must be 0.75 0.75
brick::bricktex color/texture Color or texture of the brick face 1.0
brick::brickmodtex float texture Modulation texture for the brick face 1.0
brick::motartex color/texture Texture for the mortar 0.2

Texture: dots

name type description default value
dots::inside/outside color/float texture The colour or the dots/their background. 1 and 0 respectively

Texture: fbm

name type description default value
fbm::octaves integer The number of octaves to use in the spectrum. 8
fbm::roughness float The "bumpiness" of the texture. 0.5

Texture: imagemap

name type description default value
imagemap::filename string Path to the image to use. Required. No default.
imagemap::wrap string How to wrap the texture using "repeat", "black" (black beyond texture) or "clamp" (clamps to border color) Required. No default.
imagemap::maxanisotropy float The eccentricity of the ellipse used in the EWA algorithm 8
imagemap::trilinear bool Toggle trilinear filtering on from the default (better but slower) EWA algorithm. false
imagemap::filtertype string one of: "bilinear", "mipmap_trilinear", "mipmap_ewa", "nearest". "bilinear"
imagemap::channel string one of: "mean", "red", "green", "blue","alpha", "colored_mean". "mean"

Texture: marble

name type description default value
marble::octaves integer The number of octaves to use in the spectrum. 8
marble::roughness float The "bumpiness" of the texture. 0.5
marble::scale float Scaling factor for the noise input. 1
marble::variation float moderates perturbation magnitude 0.2

Texture: mix

name type description default value
mix::tex1/tex2 color/float/fresnel texture The two textures (of the same type) to mix with the "mix" texture. 0 and 1 respectively
mix::amount float texture The degree of mix between the two textures while linearly interpolating between them. 0.5

Texture: scale

name type description default value
constant::value color/float/fresnel texture The constant value of this texture. 1
scale::tex1/tex2 color/float/fresnel texture The textures to multiply by the "scale" texture 1

Texture: wrinkled

name type description default value
wrinkled::octaves integer The number of octaves of to use in the spectrum. 8
wrinkled::roughness float The "bumpiness" of the texture. 0.5


Blender procedural textures emulation

LuxRender includes some code imported (indeed with author's permission) form the Blender sources in order to emulate Blender procedural textures. The list is of supported textures is:

  • blender_clouds
  • blender_distortednoise
  • blender_noise
  • blender_magic
  • blender_marble
  • blender_musgrave
  • blender_stucci
  • blender_wood
  • blender_voronoi

A usage example:

Texture "mat_proc::col1" "color" "constant" "color value" [1.0 1.0 1.0]
Texture "mat_proc::col2" "color" "constant" "color value" [1.0 0.0 0.0]
Texture "mat_proc::blender_musgrave" "float" "blender_musgrave"
Texture "mat_proc::mix" "color" "mix" "texture tex1" ["mat_proc::col1"] "texture tex2" ["mat_proc::col2"] "texture amount ["mat_proc::blender_musgrave"]
Texture "mat_proc::Kd.scale" "color" "scale" "texture tex1" ["mat_proc::mix"] "color tex2" [0.900000 0.900000 0.900000]
MakeNamedMaterial "mat_proc" "string type" ["matte"] "texture Kd" ["mat_proc::Kd.scale"] "float sigma" [0.000000] "float bumpmap" [0.000000]

Texture: blender_clouds

name type description default value
blender_clouds:noisetype string Noise type. One of: 'soft_noise', 'hard_noise' soft_noise
blender_clouds:noisebasis string Noise basis type. One of: 'blender_original', 'original_perlin', 'improved_perlin', 'voronoi_f1', 'voronoi_f2', 'voronoi_f3', 'voronoi_f4', 'voronoi_f2f1', 'voronoi_crackle', 'cell_noise' blender_original
blender_clouds:noisesize float 0.25
blender_clouds:noisedepth integer 2
blender_clouds:bright float Brightness 1.0
blender_clouds:contrast float 1.0

Texture: blender_distortednoise

name type description default value

Texture: blender_magic

name type description default value

Texture: blender_marble

name type description default value
blender_marble::noisesize float Blender Texture Button(F6) -> Marble -> NoiseSize 0.25
blender_marble::noisedepth integer Blender Texture Button(F6) -> Marble -> NoiseDepth 2
blender_marble::turbulance float Blender Texture Button(F6) -> Marble -> Turbulence 5.0
blender_marble::type string Blender Texture Button(F6) -> Marble -> Soft/Sharp/Sharper (valid values: soft, sharp, sharper) soft
blender_marble::noisetype string Blender Texture Button(F6) -> Marble -> Soft Noise/Hard Noise (valid values: soft_noise, hard_noise) hard_noise
blender_marble::noisebasis string Blender Texture Button(F6) -> Marble -> Sin/Saw/Tri (valid values: sin, saw, tri) sin
blender_marble::noisebasis2 string Blender Texture Button(F6) -> Marble -> Type (valid values: blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2f1, voronoi_crackle, cell_noise) blender_original
blender_marble::bright float Blender Texture Button(F6) -> Colors -> Bright 1.0
blender_marble::contrast float Blender Texture Button(F6) -> Colors -> Contrast 1.0

Texture: blender_musgrave

name type description default value
blender_musgrave::h float Blender Texture Button(F6) -> Musgrave -> H 1.0
blender_musgrave::lacu float Blender Texture Button(F6) -> Musgrave -> Lacu 2.0
blender_musgrave::octs float Blender Texture Button(F6) -> Musgrave -> Octs 2.0
blender_musgrave::gain float Blender Texture Button(F6) -> Musgrave -> (Ridget Multifractal, Hybrid Multifractal) Gain 1.0
blender_musgrave::offset float Blender Texture Button(F6) -> Musgrave -> (Ridget Multifractal, Hybrid Multifractal, Hetero Terrain) Ofst 1.0
blender_musgrave::noisesize float Blender Texture Button(F6) -> Musgrave -> NoiseSize 0.25
blender_musgrave::outscale float Blender Texture Button(F6) -> Musgrave -> iScale 1.0
blender_musgrave::type string Blender Texture Button(F6) -> Musgrave -> Type (valid values: multifractal, ridged_multifractal, hybrid_multifractal, hetero_terrain, fbm) multifractal
blender_musgrave::noisebasis string Blender Texture Button(F6) -> Musgrave -> Type (valid values: blender_original, original_perlin, improved_perlin, voronoi_f1, voronoi_f2, voronoi_f3, voronoi_f4, voronoi_f2f1, voronoi_crackle, cell_noise) blender_original
blender_musgrave::bright float Blender Texture Button(F6) -> Colors -> Bright 1.0
blender_musgrave::contrast float Blender Texture Button(F6) -> Colors -> Contrast 1.0

Texture: blender_noise

This texture has no parameters of its own, only the 3D transform properties

Texture: blender_stucci

name type description default value

Texture: blender_wood

name type description default value
blender_wood:type string Pattern type. One of: 'bands', 'rings', 'bandnoise', 'ringnoise' bands
blender_wood:noisetype string Noise type. One of: 'soft_noise', 'hard_noise' soft_noise
blender_wood:noisebasis string Noise basis type. One of: 'blender_original', 'original_perlin', 'improved_perlin', 'voronoi_f1', 'voronoi_f2', 'voronoi_f3', 'voronoi_f4', 'voronoi_f2f1', 'voronoi_crackle', 'cell_noise' blender_original
blender_wood:noisebasis2 string One of: 'sin', 'saw', 'tri' sin
blender_wood:noisesize float 0.25
blender_wood:turbulence float 5.0
blender_wood:bright float Brightness 1.0
blender_wood:contrast float 1.0

Texture: blender_voronoi

name type description default value