CompositorEffect

Documentation

Overview

Package CompositorEffect provides methods for working with CompositorEffect object instances.

Index

• type Advanced
• type Any
• type EffectCallbackType
• type Implementation
• type Instance
  • func New() Instance
  • func (self Instance) AccessResolvedColor() bool
  • func (self Instance) AccessResolvedDepth() bool
  • func (self Instance) AsCompositorEffect() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) AsResource() Resource.Instance
  • func (self Instance) EffectCallbackType() gdclass.CompositorEffectEffectCallbackType
  • func (self Instance) Enabled() bool
  • func (self Instance) NeedsMotionVectors() bool
  • func (self Instance) NeedsNormalRoughness() bool
  • func (self Instance) NeedsSeparateSpecular() bool
  • func (self Instance) SetAccessResolvedColor(value bool)
  • func (self Instance) SetAccessResolvedDepth(value bool)
  • func (self Instance) SetEffectCallbackType(value gdclass.CompositorEffectEffectCallbackType)
  • func (self Instance) SetEnabled(value bool)
  • func (self Instance) SetNeedsMotionVectors(value bool)
  • func (self Instance) SetNeedsNormalRoughness(value bool)
  • func (self Instance) SetNeedsSeparateSpecular(value bool)
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type Interface

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsCompositorEffect() Instance
}

type EffectCallbackType

type EffectCallbackType = gdclass.CompositorEffectEffectCallbackType //gd:CompositorEffect.EffectCallbackType

const (
	/*The callback is called before our opaque rendering pass, but after depth prepass (if applicable).*/
	EffectCallbackTypePreOpaque EffectCallbackType = 0
	/*The callback is called after our opaque rendering pass, but before our sky is rendered.*/
	EffectCallbackTypePostOpaque EffectCallbackType = 1
	/*The callback is called after our sky is rendered, but before our back buffers are created (and if enabled, before subsurface scattering and/or screen space reflections).*/
	EffectCallbackTypePostSky EffectCallbackType = 2
	/*The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers.*/
	EffectCallbackTypePreTransparent EffectCallbackType = 3
	/*The callback is called after our transparent rendering pass, but before any build in post effects and output to our render target.*/
	EffectCallbackTypePostTransparent EffectCallbackType = 4
	/*Represents the size of the [enum EffectCallbackType] enum.*/
	EffectCallbackTypeMax EffectCallbackType = 5
)

type Implementation

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance

type Instance [1]gdclass.CompositorEffect

This resource defines a custom rendering effect that can be applied to [Viewport]s through the viewports' [Environment]. You can implement a callback that is called during rendering at a given stage of the rendering pipeline and allows you to insert additional passes. Note that this callback happens on the rendering thread. CompositorEffect is an abstract base class and must be extended to implement specific rendering logic.

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=CompositorEffect)

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AccessResolvedColor

func (self Instance) AccessResolvedColor() bool

func (Instance) AccessResolvedDepth

func (self Instance) AccessResolvedDepth() bool

func (Instance) AsCompositorEffect

func (self Instance) AsCompositorEffect() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) AsResource

func (self Instance) AsResource() Resource.Instance

func (Instance) EffectCallbackType

func (self Instance) EffectCallbackType() gdclass.CompositorEffectEffectCallbackType

func (Instance) Enabled

func (self Instance) Enabled() bool

func (Instance) NeedsMotionVectors

func (self Instance) NeedsMotionVectors() bool

func (Instance) NeedsNormalRoughness

func (self Instance) NeedsNormalRoughness() bool

func (Instance) NeedsSeparateSpecular

func (self Instance) NeedsSeparateSpecular() bool

func (Instance) SetAccessResolvedColor

func (self Instance) SetAccessResolvedColor(value bool)

func (Instance) SetAccessResolvedDepth

func (self Instance) SetAccessResolvedDepth(value bool)

func (Instance) SetEffectCallbackType

func (self Instance) SetEffectCallbackType(value gdclass.CompositorEffectEffectCallbackType)

func (Instance) SetEnabled

func (self Instance) SetEnabled(value bool)

func (Instance) SetNeedsMotionVectors

func (self Instance) SetNeedsMotionVectors(value bool)

func (Instance) SetNeedsNormalRoughness

func (self Instance) SetNeedsNormalRoughness(value bool)

func (Instance) SetNeedsSeparateSpecular

func (self Instance) SetNeedsSeparateSpecular(value bool)

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type Interface

type Interface interface {
	//Implement this function with your custom rendering code. [param effect_callback_type] should always match the effect callback type you've specified in [member effect_callback_type]. [param render_data] provides access to the rendering state, it is only valid during rendering and should not be stored.
	RenderCallback(effect_callback_type int, render_data [1]gdclass.RenderData)
}