openrndr-draw/org.openrndr.draw/RenderTarget

RenderTarget

interface RenderTarget(source)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
abstract val contentScale: Double

Content scaling factor.

Link copied to clipboard
abstract val depthBuffer: DepthBuffer?
Link copied to clipboard
open val effectiveHeight: Int

Effective height in pixels.

Link copied to clipboard
open val effectiveWidth: Int

Effective width in pixels.

Link copied to clipboard
abstract val hasColorAttachments: Boolean

Indicates if this RenderTarget has at least one ColorAttachment.

Link copied to clipboard
abstract val hasDepthBuffer: Boolean

Indicates if this RenderTarget has a DepthBuffer with depth component

Link copied to clipboard
abstract val hasStencilBuffer: Boolean

Indicates if this RenderTarget has a DepthBuffer with stencil index

Link copied to clipboard
abstract val height: Int

Height in display units.

Link copied to clipboard
abstract val multisample: BufferMultisample

Multisampling mode.

Link copied to clipboard
open val pixelHeight: Int

Effective height in pixels.

Link copied to clipboard
open val pixelWidth: Int

Effective width in pixels.

Link copied to clipboard
abstract val session: Session?

Session in which this render target is created.

Link copied to clipboard
abstract val width: Int

Width in display units.

Functions

Link copied to clipboard
abstract fun attach(depthBuffer: DepthBuffer, ownedByRenderTarget: Boolean = false)
abstract fun attach(arrayTexture: ArrayTexture, layer: Int, level: Int = 0, name: String? = null)
abstract fun attach(colorBuffer: ColorBuffer, level: Int = 0, name: String? = null, ownedByRenderTarget: Boolean = false)
abstract fun attach(cubemap: Cubemap, side: CubemapSide, level: Int = 0, name: String? = null)
abstract fun attach(volumeTexture: VolumeTexture, layer: Int, level: Int = 0, name: String? = null)
abstract fun attach(arrayCubemap: ArrayCubemap, side: CubemapSide, layer: Int, level: Int = 0, name: String? = null)
Link copied to clipboard
abstract fun attachLayered(arrayCubemap: ArrayCubemap, level: Int = 0, name: String? = null)
abstract fun attachLayered(arrayTexture: ArrayTexture, level: Int = 0, name: String? = null)
abstract fun attachLayered(cubemap: Cubemap, level: Int = 0, name: String? = null)
abstract fun attachLayered(volumeTexture: VolumeTexture, level: Int = 0, name: String? = null)
Link copied to clipboard
abstract fun bind()

Binds the RenderTarget to the active target.

Link copied to clipboard
abstract fun blendMode(index: Int, blendMode: BlendMode)

Set the BlendMode for a ColorAttachment.

Link copied to clipboard
abstract fun clearColor(index: Int, color: ColorRGBa)

Clear a color attachment.

Link copied to clipboard
abstract fun clearDepth(depth: Double = 1.0, stencil: Int = 0)

Clear the depth attachment.

Link copied to clipboard
Link copied to clipboard
open fun colorAttachmentIndexByName(name: String): Int?

Find the index of a ColorAttachment by name.

Link copied to clipboard
abstract fun colorBuffer(index: Int): ColorBuffer

Get a color attachment as a ColorBuffer.

Link copied to clipboard
abstract fun destroy()

Destroy the RenderTarget.

Link copied to clipboard
abstract fun detachColorAttachments()

Detach all color attachments.

Link copied to clipboard
abstract fun detachDepthBuffer()

Detach the depthBuffer.

Link copied to clipboard
open fun resolveTo(to: RenderTarget)
Link copied to clipboard
abstract fun unbind()

Unbinds the RenderTarget from the active target.