PenImage

A UGen that writes the pixels of an image using an x and y input signal. It uses either a sinc-based band-limited resampling algorithm, or bicubic interpolation, depending on the zeroCrossings parameter.

All window defining parameters (width, height) are polled once per matrix. All writing and filter parameters are polled one per output pixel.

src: the source signal's amplitude or "pen color"
alpha: the alpha component of the source signal (0.0 transparent to 1.0 opaque).
dst: the "background" image to draw on. A DC(0.0) can be used, for example, to have a "black" background.
width: the width (number of columns) of the input and output matrix
height: the height (number of rows) of the input and output matrix
x: horizontal position of the dynamic pen signal
y: vertical position of the dynamic pen signal
next: a trigger that causes the UGen to emit the current image and begin a new one. An image of size width * height will be output, and new background data will be read from in.
rule: quasi-Porter-Duff rule id for composition between background (in) and pen foreground. It is assumed that A_r = A_d = 1, and instead of addition we use a custom binary operation op. Where the constrain leads to otherwise identical rules, we flip the operand order (e.g. SrcOver versus SrcAtop).
op: BinaryOp.Op identifier for the operand in the application of the Porter-Duff composition (+ in the standard definition).
wrap: if non-zero, wraps coordinates around the input images boundaries. TODO: currently wrap = 0 is broken if using sinc interpolation!
rollOff: the FIR anti-aliasing roll-off width. Between zero and one.
kaiserBeta: the FIR windowing function's parameter
zeroCrossings: the number of zero-crossings in the truncated and windowed sinc FIR. If zero (default), algorithm uses bicubic interpolation instead.

See also: ScanImage

Linear Supertypes

Serializable, Serializable, SingleOut, SomeOut[StreamOut], GE.Lazy, GE, UGenSource[UGenInLike, StreamOut], Expander[UGenInLike], Lazy, Product, Equals, AnyRef, Any

Instance Constructors

new PenImage(src: GE = 1.0, alpha: GE = 1.0, dst: GE = 0.0, width: GE, height: GE, x: GE = 0, y: GE = 0, next: GE = 0, rule: GE = PenImage.SrcOver, op: GE = BinaryOp.Plus.id, wrap: GE = 0, rollOff: GE = 0.86, kaiserBeta: GE = 7.5, zeroCrossings: GE = 0)

src
the source signal's amplitude or "pen color"
alpha
the alpha component of the source signal (0.0 transparent to 1.0 opaque).
dst
the "background" image to draw on. A DC(0.0) can be used, for example, to have a "black" background.
width
the width (number of columns) of the input and output matrix
height
the height (number of rows) of the input and output matrix
x
horizontal position of the dynamic pen signal
y
vertical position of the dynamic pen signal
next
a trigger that causes the UGen to emit the current image and begin a new one. An image of size width * height will be output, and new background data will be read from in.
rule
quasi-Porter-Duff rule id for composition between background (in) and pen foreground. It is assumed that A_r = A_d = 1, and instead of addition we use a custom binary operation op. Where the constrain leads to otherwise identical rules, we flip the operand order (e.g. SrcOver versus SrcAtop).
op
BinaryOp.Op identifier for the operand in the application of the Porter-Duff composition (+ in the standard definition).
wrap
if non-zero, wraps coordinates around the input images boundaries. TODO: currently wrap = 0 is broken if using sinc interpolation!
rollOff
the FIR anti-aliasing roll-off width. Between zero and one.
kaiserBeta
the FIR windowing function's parameter
zeroCrossings
the number of zero-crossings in the truncated and windowed sinc FIR. If zero (default), algorithm uses bicubic interpolation instead.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val alpha: GE

the alpha component of the source signal (0.0 transparent to 1.0 opaque).
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dst: GE

the "background" image to draw on.
the "background" image to draw on. A DC(0.0) can be used, for example, to have a "black" background.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val height: GE

the height (number of rows) of the input and output matrix
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val kaiserBeta: GE

the FIR windowing function's parameter
def makeUGen(args: IndexedSeq[UGenIn])(implicit b: Builder): UGenInLike

Attributes
protected
Definition Classes
PenImage → UGenSource
def makeUGens(implicit b: Builder): UGenInLike

Abstract method which must be implemented by creating the actual UGens during expansion.
Abstract method which must be implemented by creating the actual UGens during expansion. This method is at most called once during graph expansion
returns
the expanded object (depending on the type parameter U)

Attributes
protected
Definition Classes
PenImage → Expander
final def name: String

Definition Classes
UGenSource
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val next: GE

a trigger that causes the UGen to emit the current image and begin a new one.
a trigger that causes the UGen to emit the current image and begin a new one. An image of size width * height will be output, and new background data will be read from in.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val op: GE

BinaryOp.Op identifier for the operand in the application of the Porter-Duff composition (+ in the standard definition).
val rollOff: GE

the FIR anti-aliasing roll-off width.
the FIR anti-aliasing roll-off width. Between zero and one.
val rule: GE

quasi-Porter-Duff rule id for composition between background (in) and pen foreground.
quasi-Porter-Duff rule id for composition between background (in) and pen foreground. It is assumed that A_r = A_d = 1, and instead of addition we use a custom binary operation op. Where the constrain leads to otherwise identical rules, we flip the operand order (e.g. SrcOver versus SrcAtop).
val src: GE

the source signal's amplitude or "pen color"
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val width: GE

the width (number of columns) of the input and output matrix
val wrap: GE

if non-zero, wraps coordinates around the input images boundaries.
if non-zero, wraps coordinates around the input images boundaries. TODO: currently wrap = 0 is broken if using sinc interpolation!
val x: GE

horizontal position of the dynamic pen signal
val y: GE

vertical position of the dynamic pen signal
val zeroCrossings: GE

the number of zero-crossings in the truncated and windowed sinc FIR.
the number of zero-crossings in the truncated and windowed sinc FIR. If zero (default), algorithm uses bicubic interpolation instead.

Related Docs: object PenImage | package graph

Instance Constructors

new PenImage(src: GE = 1.0, alpha: GE = 1.0, dst: GE = 0.0, width: GE, height: GE, x: GE = 0, y: GE = 0, next: GE = 0, rule: GE = PenImage.SrcOver, op: GE = BinaryOp.Plus.id, wrap: GE = 0, rollOff: GE = 0.86, kaiserBeta: GE = 7.5, zeroCrossings: GE = 0)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val alpha: GE

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val dst: GE

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val height: GE

final def isInstanceOf[T0]: Boolean

val kaiserBeta: GE

def makeUGen(args: IndexedSeq[UGenIn])(implicit b: Builder): UGenInLike

def makeUGens(implicit b: Builder): UGenInLike

final def name: String

final def ne(arg0: AnyRef): Boolean

val next: GE

final def notify(): Unit

final def notifyAll(): Unit

val op: GE

val rollOff: GE

val rule: GE

val src: GE

final def synchronized[T0](arg0: ⇒ T0): T0

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val width: GE

val wrap: GE

val x: GE

val y: GE

val zeroCrossings: GE

Inherited from Serializable

Inherited from Serializable

Inherited from SingleOut

Inherited from SomeOut[StreamOut]

Inherited from GE.Lazy

Inherited from GE

Inherited from UGenSource[UGenInLike, StreamOut]

Inherited from Expander[UGenInLike]

Inherited from Lazy

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped