<!--
{
  "availability" : [
    "iOS: 18.0.0 -",
    "iPadOS: 18.0.0 -",
    "macCatalyst: 18.0.0 -",
    "macOS: 15.0.0 -",
    "tvOS: 26.0.0 -",
    "visionOS: 2.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "RealityKit",
  "identifier" : "/documentation/RealityKit/PortalComponent/init(target:clippingMode:crossingMode:)",
  "metadataVersion" : "0.1.0",
  "role" : "Initializer",
  "symbol" : {
    "kind" : "Initializer",
    "modules" : [
      "RealityKit"
    ],
    "preciseIdentifier" : "s:17RealityFoundation15PortalComponentV6target12clippingMode08crossingG0AcA6EntityC_AC08ClippingG0OAC08CrossingG0Otcfc"
  },
  "title" : "init(target:clippingMode:crossingMode:)"
}
-->

# init(target:clippingMode:crossingMode:)

Creates a portal component with a target entity, clipping mode, and crossing mode.

```
init(target: Entity, clippingMode: PortalComponent.ClippingMode, crossingMode: PortalComponent.CrossingMode)
```

## Parameters

`target`

A target world entity the portal is looking into.

`clippingMode`

A configuration for the portal’s clipping feature.

`crossingMode`

A configuration for the portal’s crossing feature.

## Discussion

To render a portal, an entity needs a [`PortalComponent`](/documentation/RealityKit/PortalComponent) and a [`ModelComponent`](/documentation/RealityKit/ModelComponent), using one or
more [`PortalMaterial`](/documentation/RealityKit/PortalMaterial) instances.

The target entity needs to have a [`WorldComponent`](/documentation/RealityKit/WorldComponent) or the portal does not render.

Provide [`PortalComponent.ClippingMode`](/documentation/RealityKit/PortalComponent/ClippingMode-swift.enum) and [`PortalComponent.CrossingMode`](/documentation/RealityKit/PortalComponent/CrossingMode-swift.enum) to configure the corresponding
clipping and crossing features.

Using this initializer is equivalent to setting [`targetEntity`](/documentation/RealityKit/PortalComponent/targetEntity), [`clippingMode`](/documentation/RealityKit/PortalComponent/clippingMode-swift.property) and
[`crossingMode`](/documentation/RealityKit/PortalComponent/crossingMode-swift.property) properties directly.

See [`PortalComponent`](/documentation/RealityKit/PortalComponent) for example usage.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)