RenderTarget

interface RenderTarget

Types

Companion

common

object Companion

Functions

attach

common

abstract fun attach(depthBuffer: DepthBuffer)

abstract fun attach(colorBuffer: ColorBuffer, level: Int = 0, name: String? = null)

abstract fun attach(arrayTexture: ArrayTexture, layer: Int, level: Int = 0, name: String? = null)

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)

attachLayered

common

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)

bind

common

abstract fun bind()

binds the RenderTarget to the active target

blendMode

common

abstract fun blendMode(index: Int, blendMode: BlendMode)

set the BlendMode for a ColorAttachment

clearColor

common

abstract fun clearColor(index: Int, color: ColorRGBa)

clear a color attachment

clearDepth

common

abstract fun clearDepth(depth: Double = 1.0, stencil: Int = 0)

clear the depth attachment

colorAttachmentByName

common

open fun colorAttachmentByName(name: String): ColorAttachment?

find color attachment by name

colorAttachmentIndexByName

common

open fun colorAttachmentIndexByName(name: String): Int?

find color attachment index by name

colorBuffer

common

abstract fun colorBuffer(index: Int): ColorBuffer

get a color attachment as a ColorBuffer

destroy

common

abstract fun destroy()

destroy the RenderTarget to properly destroy destroy color attachments and depth attachment first then use detachColorAttachments and detachDepthBuffer before calling destroy

detachColorAttachments

common

abstract fun detachColorAttachments()

detach all color attachments

detachColorBuffers

common

~~abstract~~ ~~fun~~ ~~detachColorBuffers~~()

detachDepthBuffer

common

abstract fun detachDepthBuffer()

detach depth buffer

resolveTo

common

open fun resolveTo(to: RenderTarget)

unbind

common

abstract fun unbind()

unbinds the RenderTarget from the active target

Properties

colorAttachments

common

abstract val colorAttachments: List<ColorAttachment>

list of ColorAttachments

contentScale

common

abstract val contentScale: Double

content scaling factor

depthBuffer

common

abstract val depthBuffer: DepthBuffer?

depthBuffer

effectiveHeight

common

open val effectiveHeight: Int

effective height in pixels

effectiveWidth

common

open val effectiveWidth: Int

effective width in pixels

hasColorAttachments

common

abstract val hasColorAttachments: Boolean

indicates that this RenderTarget has at least one ColorAttachment

hasDepthBuffer

common

abstract val hasDepthBuffer: Boolean

indicates that this RenderTarget has a DepthBuffer

height

common

abstract val height: Int

height in display units

multisample

common

abstract val multisample: BufferMultisample

multisample mode

session

common

abstract val session: Session?

Session in which this render target is created

width

common

abstract val width: Int

width in display units