correction

Used for Color Correction Window operations.


xshade
↑
scene
↑
correction

List of Methods

correct Applies the currently set color correction to the color passed in the argument and returns the results
load Loads color correction settings from a file
save Saves color correction settings to a file

List of Properties

bias The bias
color_shift The color shift (color)
contrast The contrast
gain The gain
gamma The gamma
highlight_hue The highlight hue
highlight_saturation The highlight saturation
mid_hue The middle tone hue
mid_saturation The middle tone saturation
shadow_hue The shadow hue
shadow_saturation The shadow saturation




Method Details

correct

Applies the currently set color correction to the color passed in the argument and return the results.
Return value :
  rgb
Arguments :
  rgb

#Return color correction results for [1.0, 0.0, 0.0]
print xshade.scene().correction.correct([1.0, 0.0, 0.0])

load

Loads color correction settings from a file.
Arguments :
  file_path
See also :
  save

#Load color correction settings from sample.shdcor
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(True, '*.shdcor|shdcor')
xshade.scene().correction.load(file_path)

save

Saves color correction settings to a file.
Arguments :
  file_path
See also :
  load

#Save color correction settings to sample.shdcor
dialog = xshade.create_dialog_with_uuid()
file_path = dialog.ask_path(False, '*.shdcor|shdcor')
xshade.scene().correction.save(file_path)

Property Details

bias

The bias.

  • Get
  • Set

Type :
  float

print xshade.scene().correction.bias

color_shift

The color shift (color).

  • Get
  • Set

Type :
  float

print xshade.scene().correction.color_shift

contrast

The contrast.

  • Get
  • Set

Type :
  float

print xshade.scene().correction.contrast

gain

The gain.

  • Get
  • Set

Type :
  float

print xshade.scene().correction.gain

gamma

The gamma.

  • Get
  • Set

Type :
  float

print xshade.scene().correction.gamma

highlight_hue

The highlight hue.

  • Get
  • Set

Type :
  radian

print xshade.scene().correction.highlight_hue

highlight_saturation

The highlight saturation.

  • Get
  • Set

Type :
  float

print xshade.scene().correction.highlight_saturation

mid_hue

The middle tone hue.

  • Get
  • Set

Type :
  radian

print xshade.scene().correction.mid_hue

mid_saturation

The middle tone saturation.

  • Get
  • Set

Type :
  float

print xshade.scene().correction.mid_saturation

shadow_hue

The shadow hue.

  • Get
  • Set

Type :
  radian

print xshade.scene().correction.shadow_hue

shadow_saturation

The shadow saturation.

  • Get
  • Set

Type :
  float

print xshade.scene().correction.shadow_saturation