background layer

Used for background layer operations.
Background settings are composed of 0 or more layers; background_layer expresses one of those layers.


xshade
scene
background
background_layer

List of Properties

anisotropic Anisotropic
area Area used by the mapping image
blend_mode Blend Mode
density Density
horizontal_flip Horizontal Flip on/off
image The mapping image
mapping_color The mapping color
mapping_size The mapping size
orientation Orientation
phase Phase
premultiplied Premultiplied Alpha on/off
projection Projection map type
swap_axes Swap axes on/off
target Target area of the background layer
texture Texture pattern type
vertical_flip Vertical Flip on/off
weight Mapping blend weight




Property Details

anisotropic

Anisotropic.

  • Get
  • Set

Type :
  float

print xshade.scene().background.background_layer(0).anisotropic

area

Area used by the mapping image.

  • Get
  • Set

Type :
  rectangle

print xshade.scene().background.background_layer(0).area

blend_mode

Blend Mode.

  • Get
  • Set

Type :
  int :

0Normal
1Alpha Blend
2Add
3Subtract
4Multiply
5Max
6Min
print xshade.scene().background.background_layer(0).blend_mode

density

Density.

  • Get
  • Set

Type :
  float

print xshade.scene().background.background_layer(0).density

horizontal_flip

Horizontal Flip on/off.

  • Get
  • Set

Type :
  bool

print xshade.scene().background.background_layer(0).horizontal_flip

image

The mapping image.

  • Get
  • Set

Type :
  image object
See also :
  image

#Output the mapping image size
print xshade.scene().background.background_layer(0).image.size

mapping_color

The mapping color.

  • Get
  • Set

Type :
  rgb

print xshade.scene().background.background_layer(0).mapping_color

mapping_size

The mapping size.

  • Get
  • Set

Type :
  float

print xshade.scene().background.background_layer(0).mapping_size

orientation

Orientation.

  • Get
  • Set

Type :
  float

print xshade.scene().background.background_layer(0).orientation

phase

Phase.

  • Get
  • Set

Type :
  float
Phase parameter of Cloud, Wave, and Ocean.

print xshade.scene().background.background_layer(0).phase

premultiplied

Premultiplied Alpha on/off.

  • Get
  • Set

Type :
  bool

print xshade.scene().background.background_layer(0).premultiplied

projection

Projection map type.

  • Get
  • Set

Type :
  int :

0Planar
1Spherical
2Light Probe
3Cube Map
4Vertical Cross
print xshade.scene().background.background_layer(0).projection

swap_axes

Swap axes on/off.

  • Get
  • Set

Type :
  bool

print xshade.scene().background.background_layer(0).swap_axes

target

Target area of the background layer.

  • Get
  • Set

Type :
  int :

1Upper hemisphere
2Lower hemisphere
3Whole
print xshade.scene().background.background_layer(0).target

texture

Texture pattern type.

  • Get
  • Set

Type :
  int :

0None
1Cloud
2Ocean
3Marble
4Spotted
5Checked
6Haze
7Image
print xshade.scene().background.background_layer(0).texture

vertical_flip

Vertical Flip on/off.

  • Get
  • Set

Type :
  bool

print xshade.scene().background.background_layer(0).vertical_flip

weight

Mapping blend weight.

  • Get
  • Set

Type :
  float

print xshade.scene().background.background_layer(0).weight