PixelFilter

PixelFilter#

(Pixel Filter)

Abstract Class
Default object name: pixel_filter
Inherits from: ProjectItem > ImageFilter
Inherited by: ImageFilterAdd, ImageFilterAutoLevel, ImageFilterBrightness, ImageFilterCdl, ImageFilterColorSpace, ImageFilterContrast, ImageFilterCutOff, ImageFilterGamma, ImageFilterHueSaturation, ImageFilterInvert, ImageFilterMultiply, ImageFilterNan, ImageFilterNoise, ImageFilterRemap, ImageFilterSubtract

No corresponding User page.

Description#

Image filters are single pixel filters. The result of the process for each pixel depend on the value of the pixel only.

Public Attributes#

Type	Name	Visual Hint	Description
`bool`	`channel_r`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the red channel or not.
`bool`	`channel_g`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the green channel or not.
`bool`	`channel_b`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the blue channel or not.
`bool`	`channel_a`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the alpha channel or not.
`bool`	`channel_z`	`VISUAL_HINT_DEFAULT`	Whether this filter affects the Z channel or not.

CID#

class "PixelFilter" "ImageFilter" {
    abstract yes
    #version 0.9
    icon "../icons/object_icons/filter_pixel.iconrc"
    doc "Image filters are single pixel filters. The result of the process for each pixel depend on the value of the pixel only."
    attribute_group "channels" {
        bool "channel_r" {
            doc "Whether this filter affects the red channel or not."
            animatable yes
            value yes
        }
        bool "channel_g" {
            doc "Whether this filter affects the green channel or not."
            animatable yes
            value yes
        }
        bool "channel_b" {
            doc "Whether this filter affects the blue channel or not."
            animatable yes
            value yes
        }
        bool "channel_a" {
            doc "Whether this filter affects the alpha channel or not."
            animatable yes
            value yes
        }
        bool "channel_z" {
            doc "Whether this filter affects the Z channel or not."
            animatable yes
            value no
        }
    }
}