Class RenderViewport | Package Manager UI website
docs.unity3d.com
    Show / Hide Table of Contents

    Class RenderViewport

    Inheritance
    System.Object
    Diagnosticable
    DiagnosticableTree
    AbstractNodeMixinDiagnosticableTree
    RenderObject
    RenderBox
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>
    RenderViewportBase<SliverPhysicalContainerParentData>
    RenderViewport
    RenderNestedScrollViewViewport
    Inherited Members
    RenderViewportBase<SliverPhysicalContainerParentData>.parent
    RenderViewportBase<SliverPhysicalContainerParentData>.axisDirection
    RenderViewportBase<SliverPhysicalContainerParentData>.crossAxisDirection
    RenderViewportBase<SliverPhysicalContainerParentData>.axis
    RenderViewportBase<SliverPhysicalContainerParentData>.offset
    RenderViewportBase<SliverPhysicalContainerParentData>.cacheExtent
    RenderViewportBase<SliverPhysicalContainerParentData>.attach(Object)
    RenderViewportBase<SliverPhysicalContainerParentData>.detach()
    RenderViewportBase<SliverPhysicalContainerParentData>.debugThrowIfNotCheckingIntrinsics()
    RenderViewportBase<SliverPhysicalContainerParentData>.computeMinIntrinsicWidth(Single)
    RenderViewportBase<SliverPhysicalContainerParentData>.computeMaxIntrinsicWidth(Single)
    RenderViewportBase<SliverPhysicalContainerParentData>.computeMinIntrinsicHeight(Single)
    RenderViewportBase<SliverPhysicalContainerParentData>.computeMaxIntrinsicHeight(Single)
    RenderViewportBase<SliverPhysicalContainerParentData>.isRepaintBoundary
    RenderViewportBase<SliverPhysicalContainerParentData>.layoutChildSequence(RenderSliver, Single, Single, Single, Single, Single, Single, GrowthDirection, Func<RenderSliver, RenderSliver>, Single, Single)
    RenderViewportBase<SliverPhysicalContainerParentData>.describeApproximatePaintClip(RenderObject)
    RenderViewportBase<SliverPhysicalContainerParentData>.paint(PaintingContext, Offset)
    RenderViewportBase<SliverPhysicalContainerParentData>._paintContents(PaintingContext, Offset)
    RenderViewportBase<SliverPhysicalContainerParentData>.debugPaintSize(PaintingContext, Offset)
    RenderViewportBase<SliverPhysicalContainerParentData>.hitTestChildren(HitTestResult, Offset)
    RenderViewportBase<SliverPhysicalContainerParentData>.getOffsetToReveal(RenderObject, Single, Rect)
    RenderViewportBase<SliverPhysicalContainerParentData>.computeAbsolutePaintOffset(RenderSliver, Single, GrowthDirection)
    RenderViewportBase<SliverPhysicalContainerParentData>.debugDescribeChildren()
    RenderViewportBase<SliverPhysicalContainerParentData>.showOnScreen(RenderObject, Rect, Nullable<TimeSpan>, Curve)
    RenderViewportBase<SliverPhysicalContainerParentData>.showInViewport(RenderObject, Rect, RenderAbstractViewport, ViewportOffset, Nullable<TimeSpan>, Curve)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.childCount
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.debugValidateChild(RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.insert(RenderSliver, RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.add(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.addAll(List<RenderSliver>)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>._removeFromChildList(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.remove(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.removeAll()
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.move(RenderSliver, RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.attach(Object)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.detach()
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.redepthChildren()
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.visitChildren(RenderObjectVisitor)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.firstChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.lastChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.childBefore(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.childAfter(RenderSliver)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.debugDescribeChildren()
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.ContainerRenderObjectMixin.insert(RenderObject, RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.ContainerRenderObjectMixin.remove(RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.ContainerRenderObjectMixin.move(RenderObject, RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.ContainerRenderObjectMixin.firstChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.ContainerRenderObjectMixin.lastChild
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.ContainerRenderObjectMixin.childBefore(RenderObject)
    ContainerRenderObjectMixinRenderBox<RenderSliver, SliverPhysicalContainerParentData>.ContainerRenderObjectMixin.childAfter(RenderObject)
    RenderBox.getMinIntrinsicWidth(Single)
    RenderBox.getMaxIntrinsicWidth(Single)
    RenderBox.getMinIntrinsicHeight(Single)
    RenderBox.getMaxIntrinsicHeight(Single)
    RenderBox.hasSize
    RenderBox.size
    RenderBox.debugAdoptSize(Size)
    RenderBox.semanticBounds
    RenderBox.debugResetSize()
    RenderBox.getDistanceToBaseline(TextBaseline, Boolean)
    RenderBox.getDistanceToActualBaseline(TextBaseline)
    RenderBox.computeDistanceToActualBaseline(TextBaseline)
    RenderBox.constraints
    RenderBox.debugAssertDoesMeetConstraints()
    RenderBox.markNeedsLayout()
    RenderBox.hitTest(HitTestResult, Offset)
    RenderBox.hitTestSelf(Offset)
    RenderBox.globalToLocal(Offset, RenderObject)
    RenderBox.localToGlobal(Offset, RenderObject)
    RenderBox.paintBounds
    RenderBox.debugHandleEvent(PointerEvent, HitTestEntry)
    RenderBox.debugPaint(PaintingContext, Offset)
    RenderBox.debugPaintBaselines(PaintingContext, Offset)
    RenderBox.debugPaintPointers(PaintingContext, Offset)
    RenderObject.parentData
    RenderObject.adoptChild(AbstractNodeMixinDiagnosticableTree)
    RenderObject.dropChild(AbstractNodeMixinDiagnosticableTree)
    RenderObject.visitChildren(RenderObjectVisitor)
    RenderObject.debugCreator
    RenderObject.debugDoingThisResize
    RenderObject.debugDoingThisLayout
    RenderObject.debugActiveLayout
    RenderObject.debugCanParentUseSize
    RenderObject.owner
    RenderObject.debugNeedsLayout
    RenderObject._relayoutBoundary
    RenderObject.markParentNeedsLayout()
    RenderObject.markNeedsLayoutForSizedByParentChange()
    RenderObject.scheduleInitialLayout()
    RenderObject.layout(Constraints, Boolean)
    RenderObject.invokeLayoutCallback<T>(LayoutCallback<T>)
    RenderObject.debugDoingThisPaint
    RenderObject.debugActivePaint
    RenderObject.debugRegisterRepaintBoundaryPaint(Boolean, Boolean)
    RenderObject.alwaysNeedsCompositing
    RenderObject.layer
    RenderObject.debugLayer
    RenderObject.markNeedsCompositingBitsUpdate()
    RenderObject.needsCompositing
    RenderObject._updateCompositingBits()
    RenderObject.markNeedsPaint()
    RenderObject.scheduleInitialPaint(ContainerLayer)
    RenderObject.replaceRootLayer(OffsetLayer)
    RenderObject.getTransformTo(RenderObject)
    RenderObject.handleEvent(PointerEvent, HitTestEntry)
    RenderObject.toStringShort()
    RenderObject.toString(DiagnosticLevel)
    RenderObject.toStringDeep(String, String, DiagnosticLevel)
    RenderObject.toStringShallow(String, DiagnosticLevel)
    AbstractNodeMixinDiagnosticableTree.depth
    AbstractNodeMixinDiagnosticableTree.redepthChild(AbstractNodeMixinDiagnosticableTree)
    AbstractNodeMixinDiagnosticableTree.redepthChildren()
    AbstractNodeMixinDiagnosticableTree.attached
    DiagnosticableTree.toDiagnosticsNode(String, DiagnosticsTreeStyle)
    Diagnosticable.ToString()
    Namespace: Unity.UIWidgets.rendering
    Syntax
    public class RenderViewport : RenderViewportBase<SliverPhysicalContainerParentData>, HitTestTarget, ContainerRenderObjectMixin, RenderAbstractViewport

    Constructors

    RenderViewport(AxisDirection, AxisDirection, ViewportOffset, Single, List<RenderSliver>, RenderSliver, Single)

    Declaration
    public RenderViewport(AxisDirection axisDirection = AxisDirection.down, AxisDirection crossAxisDirection = AxisDirection.right, ViewportOffset offset = null, float anchor = 0F, List<RenderSliver> children = null, RenderSliver center = null, float cacheExtent = 250F)
    Parameters
    Type Name Description
    AxisDirection axisDirection
    AxisDirection crossAxisDirection
    ViewportOffset offset
    System.Single anchor
    System.Collections.Generic.List<RenderSliver> children
    RenderSliver center
    System.Single cacheExtent

    Fields

    _anchor

    Declaration
    public float _anchor
    Field Value
    Type Description
    System.Single

    _center

    Declaration
    public RenderSliver _center
    Field Value
    Type Description
    RenderSliver

    Properties

    anchor

    Declaration
    public float anchor { get; set; }
    Property Value
    Type Description
    System.Single

    center

    Declaration
    public RenderSliver center { get; set; }
    Property Value
    Type Description
    RenderSliver

    childrenInHitTestOrder

    Declaration
    protected override IEnumerable<RenderSliver> childrenInHitTestOrder { get; }
    Property Value
    Type Description
    System.Collections.Generic.IEnumerable<RenderSliver>
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.childrenInHitTestOrder

    childrenInPaintOrder

    Declaration
    protected override IEnumerable<RenderSliver> childrenInPaintOrder { get; }
    Property Value
    Type Description
    System.Collections.Generic.IEnumerable<RenderSliver>
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.childrenInPaintOrder

    hasVisualOverflow

    Declaration
    protected override bool hasVisualOverflow { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.hasVisualOverflow

    indexOfFirstChild

    Declaration
    protected override int indexOfFirstChild { get; }
    Property Value
    Type Description
    System.Int32
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.indexOfFirstChild

    sizedByParent

    Declaration
    protected override bool sizedByParent { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    RenderObject.sizedByParent

    Methods

    applyPaintTransform(RenderObject, Matrix3)

    Declaration
    public override void applyPaintTransform(RenderObject child, Matrix3 transform)
    Parameters
    Type Name Description
    RenderObject child
    Matrix3 transform
    Overrides
    RenderBox.applyPaintTransform(RenderObject, Matrix3)

    computeChildMainAxisPosition(RenderSliver, Single)

    Declaration
    protected override float computeChildMainAxisPosition(RenderSliver child, float parentMainAxisPosition)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single parentMainAxisPosition
    Returns
    Type Description
    System.Single
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.computeChildMainAxisPosition(Unity.UIWidgets.rendering.RenderSliver, System.Single)

    debugFillProperties(DiagnosticPropertiesBuilder)

    Declaration
    public override void debugFillProperties(DiagnosticPropertiesBuilder properties)
    Parameters
    Type Name Description
    DiagnosticPropertiesBuilder properties
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.debugFillProperties(Unity.UIWidgets.foundation.DiagnosticPropertiesBuilder)

    labelForChild(Int32)

    Declaration
    protected override string labelForChild(int index)
    Parameters
    Type Name Description
    System.Int32 index
    Returns
    Type Description
    System.String
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.labelForChild(System.Int32)

    maxScrollObstructionExtentBefore(RenderSliver)

    Declaration
    protected override float maxScrollObstructionExtentBefore(RenderSliver child)
    Parameters
    Type Name Description
    RenderSliver child
    Returns
    Type Description
    System.Single
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.maxScrollObstructionExtentBefore(Unity.UIWidgets.rendering.RenderSliver)

    paintOffsetOf(RenderSliver)

    Declaration
    protected override Offset paintOffsetOf(RenderSliver child)
    Parameters
    Type Name Description
    RenderSliver child
    Returns
    Type Description
    Offset
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.paintOffsetOf(Unity.UIWidgets.rendering.RenderSliver)

    performLayout()

    Declaration
    protected override void performLayout()
    Overrides
    RenderBox.performLayout()

    performResize()

    Declaration
    protected override void performResize()
    Overrides
    RenderBox.performResize()

    scrollOffsetOf(RenderSliver, Single)

    Declaration
    protected override float scrollOffsetOf(RenderSliver child, float scrollOffsetWithinChild)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single scrollOffsetWithinChild
    Returns
    Type Description
    System.Single
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.scrollOffsetOf(Unity.UIWidgets.rendering.RenderSliver, System.Single)

    setupParentData(RenderObject)

    Declaration
    public override void setupParentData(RenderObject child)
    Parameters
    Type Name Description
    RenderObject child
    Overrides
    RenderBox.setupParentData(RenderObject)

    updateChildLayoutOffset(RenderSliver, Single, GrowthDirection)

    Declaration
    protected override void updateChildLayoutOffset(RenderSliver child, float layoutOffset, GrowthDirection growthDirection)
    Parameters
    Type Name Description
    RenderSliver child
    System.Single layoutOffset
    GrowthDirection growthDirection
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.updateChildLayoutOffset(Unity.UIWidgets.rendering.RenderSliver, System.Single, Unity.UIWidgets.rendering.GrowthDirection)

    updateOutOfBandData(GrowthDirection, SliverGeometry)

    Declaration
    protected override void updateOutOfBandData(GrowthDirection growthDirection, SliverGeometry childLayoutGeometry)
    Parameters
    Type Name Description
    GrowthDirection growthDirection
    SliverGeometry childLayoutGeometry
    Overrides
    Unity.UIWidgets.rendering.RenderViewportBase<Unity.UIWidgets.rendering.SliverPhysicalContainerParentData>.updateOutOfBandData(Unity.UIWidgets.rendering.GrowthDirection, Unity.UIWidgets.rendering.SliverGeometry)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023