RenderTarget

interface RenderTarget

Types

Companion
Link copied to clipboard
common
object Companion

Functions

attach
Link copied to clipboard
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
Link copied to clipboard
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
Link copied to clipboard
common
abstract fun bind()

binds the RenderTarget to the active target

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

clear a color attachment

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

clear the depth attachment

colorAttachmentByName
Link copied to clipboard
common
open fun colorAttachmentByName(name: String): ColorAttachment?

find color attachment by name

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

find color attachment index by name

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

get a color attachment as a ColorBuffer

destroy
Link copied to clipboard
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
Link copied to clipboard
common
abstract fun detachColorAttachments()

detach all color attachments

detachColorBuffers
Link copied to clipboard
common
abstract fun detachColorBuffers()
detachDepthBuffer
Link copied to clipboard
common
abstract fun detachDepthBuffer()

detach depth buffer

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

unbinds the RenderTarget from the active target

Properties

colorAttachments
Link copied to clipboard
common
abstract val colorAttachments: List<ColorAttachment>
contentScale
Link copied to clipboard
common
abstract val contentScale: Double

content scaling factor

depthBuffer
Link copied to clipboard
common
abstract val depthBuffer: DepthBuffer?

depthBuffer

effectiveHeight
Link copied to clipboard
common
open val effectiveHeight: Int

effective height in pixels

effectiveWidth
Link copied to clipboard
common
open val effectiveWidth: Int

effective width in pixels

hasColorAttachments
Link copied to clipboard
common
abstract val hasColorAttachments: Boolean

indicates that this RenderTarget has at least one ColorAttachment

hasDepthBuffer
Link copied to clipboard
common
abstract val hasDepthBuffer: Boolean

indicates that this RenderTarget has a DepthBuffer

height
Link copied to clipboard
common
abstract val height: Int

height in display units

multisample
Link copied to clipboard
common
abstract val multisample: BufferMultisample

multisample mode

session
Link copied to clipboard
common
abstract val session: Session?

Session in which this render target is created

width
Link copied to clipboard
common
abstract val width: Int

width in display units