image layer

Class which expresses MultiPass images. Used for MultiPass image operations.

xshade
↑
image_layer

List of Methods

get_channel_name The channel name
set_channel_name Sets the channel name

List of Properties

id_name The layer ID
image The layer image
maximum_value Reference value (maximum) when normalizing the layer
minimum_value Reference value (minimum) when normalizing the layer
name The layer path (name)
number_of_channels The number of layer channels
pixel_depth The layer color depth



Used after getting a multi-layer image with a method such as xshade.scene().rendering.image_layer_by_index(1).

Method Details

get_channel_name

The channel name.
Arguments :
　　int : The index
Return value :
　　string
See also :
　　set_channel_name 

print xshade.scene().rendering.image_layer_by_index(1).get_channel_name(0)

set_channel_name

Sets the channel name.
Arguments :
　　int : The index
Arguments :
　　string
See also :
　　get_channel_name 

xshade.scene().rendering.image_layer_by_index(1).set_channel_name(0,'red')

Property Details

id_name

The layer ID.

  • Get
  • Set

Type :
　　string

print xshade.scene().rendering.image_layer_by_index(1).id_name

image

The layer image.

  • Get
  • Set

Type :
　　image

#Open the image in a window
xshade.scene().rendering.image_layer_by_index(1).image.create_window()

maximum_value

Reference value (maximum) when normalizing the layer.

  • Get
  • Set

Type :
　　rgba
See also :
　　minimum_value
The MultiPass Position, Z Depth, and Normals passes preserve the actual dimensions internally. When drawing or saving to a file, these are normalized between RGBA(0,0,0,0) and RGBA(1,1,1,1) within the range of minimum_value and maximum_value.
When other MultiPass values are set, the intensity changes when drawing or saving to a file.
To reflect changes to a value, redraw manually. 

print xshade.scene().rendering.image_layer_by_index(1).maximum_value

minimum_value

Reference value (minimum) when normalizing the layer.

  • Get
  • Set

Type :
　　rgba
See also :
　　maximum_value
The MultiPass Position, Z Depth, and Normals passes preserve the actual dimensions internally. When drawing or saving to a file, these are normalized between RGBA(0,0,0,0) and RGBA(1,1,1,1) within the range of minimum_value and maximum_value.
When other MultiPass values are set, the intensity changes when drawing or saving to a file.
To reflect changes to a value, redraw manually. 

print xshade.scene().rendering.image_layer_by_index(1).minimum_value

name

The layer path (name).

  • Get
  • Set

Type :
　　string

print xshade.scene().rendering.image_layer_by_index(1).name

number_of_channels

The number of layer channels.

  • Get
  • Set

Type :
　　int

print xshade.scene().rendering.image_layer_by_index(1).number_of_channels

pixel_depth

The layer color depth.

  • Get
  • Set

Type :
　　int

print xshade.scene().rendering.image_layer_by_index(1).pixel_depth