C4 Engine
C4 Engine API Documentation

PortalObject::GetPortalFlags

Defined in:  C4Portals.h
Returns the portal flags.
Prototype

uint32 GetPortalFlags(voidconst;

Description
The GetPortalFlags function returns the portal flags, which can a combination (through logical OR) of the following constants.
kPortalLightInhibit No lights shine through the portal.
kPortalStaticLightInhibit Only dynamic lights shine through the portal.
kPortalShadowMapInhibit For a direct portal, the portal is not followed when rendering a shadow map. For an indirect portal, shadows are not rendered in the image generated by the portal.
kPortalFogInhibit Do not apply fog through the portal (direct portal only).
kPortalSkyboxInhibit Do not render the skybox through the portal (indirect portal only).
kPortalOverrideClearColor Override the camera clear color when rendering through the portal (indirect portal only).
kPortalSeparateShadowMap An infinite shadow map rendered through the portal is not reused (indirect portal only). This only affects portals whose indirect transform is the identity.
kPortalAllowIndirectLight Allow lights to shine through the portal (indirect portal only).
kPortalObliqueFrustum Use an oblique view frustum when rendering through the portal (indirect portal only).
kPortalRecursive Allow the portal to be rendered recursively (indirect portal only).
kPortalDistant Render only infinitely distant objects, like the skybox, through the portal (indirect portal only).
kPortalSourceInhibit No source audio flows through the portal (direct portal only).
kPortalForceCameraZone The camera regions are rooted only in the target zone (indirect portal only).
kPortalShadowMapMaxDepth Disables an optimization that uses the maximum depth of all rendered geometries to cull infinite shadow cascades (indirect portal only). This applies to indirect portals that do not have the kPortalSeparateShadowMap flag specified.
kPortalFullShadowRegion Causes the full-size shadow region to be used on the side of the portal containing a light (direct portal only).
See Also

PortalObject::SetPortalFlags