unreal.SceneCaptureComponent2D
¶
- class unreal.SceneCaptureComponent2D(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
SceneCaptureComponent
Used to capture a ‘snapshot’ of the scene from a single plane and feed it to a render target.
C++ Source:
Module: Engine
File: SceneCaptureComponent2D.h
Editor Properties: (see get_editor_property/set_editor_property)
absolute_location
(bool): [Read-Write] If RelativeLocation should be considered relative to the world, rather than the parentabsolute_rotation
(bool): [Read-Write] If RelativeRotation should be considered relative to the world, rather than the parentabsolute_scale
(bool): [Read-Write] If RelativeScale3D should be considered relative to the world, rather than the parentalways_persist_rendering_state
(bool): [Read-Write] Whether to persist the rendering state even if bCaptureEveryFrame==false. This allows velocities for Motion Blur and Temporal AA to be computed.asset_user_data
(Array[AssetUserData]): [Read-Write] Array of user data stored with the componentasset_user_data_editor_only
(Array[AssetUserData]): [Read-Write] Array of user data stored with the componentauto_activate
(bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.auto_calculate_ortho_planes
(bool): [Read-Write] Automatically determine a min/max Near/Far clip plane position depending on OrthoWidth valueauto_plane_shift
(float): [Read-Write] Manually adjusts the planes of this camera, maintaining the distance between them. Positive moves out to the farplane, negative towards the near planecamera_cut_this_frame
(bool): [Read-Write] True if we did a camera cut this frame. Automatically reset to false at every capture. This flag affects various things in the renderer (such as whether to use the occlusion queries from last frame, and motion blur). Similar to UPlayerCameraManager::bGameCameraCutThisFrame.can_ever_affect_navigation
(bool): [Read-Write] Whether this component can potentially influence navigationcapture_every_frame
(bool): [Read-Write] Whether to update the capture’s contents every frame. If disabled, the component will render once on load and then only when moved.capture_on_movement
(bool): [Read-Write] Whether to update the capture’s contents on movement. Disable if you are going to capture manually from blueprint.capture_sort_priority
(int32): [Read-Write] Capture priority within the frame to sort scene capture on GPU to resolve interdependencies between multiple capture components. Highest come first.capture_source
(SceneCaptureSource): [Read-Write]clip_plane_base
(Vector): [Read-Write] Base position for the clip plane, can be any position on the plane.clip_plane_normal
(Vector): [Read-Write] Normal for the plane.component_tags
(Array[Name]): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.composite_mode
(SceneCaptureCompositeMode): [Read-Write] When enabled, the scene capture will composite into the render target instead of overwriting its contents.consider_unrendered_opaque_pixel_as_fully_translucent
(bool): [Read-Write] Whether to only render exponential height fog on opaque pixels which were rendered by the scene capture.custom_near_clipping_plane
(float): [Read-Write] Set bOverride_CustomNearClippingPlane to true if you want to use a custom clipping plane instead of GNearClippingPlane.custom_projection_matrix
(Matrix): [Read-Write] The custom projection matrix to usedetail_mode
(DetailMode): [Read-Write] If detail mode is >= system detail mode, primitive won’t be rendered.editable_when_inherited
(bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor classenable_clip_plane
(bool): [Read-Write] Enables a clip plane while rendering the scene capture which is useful for portals. The global clip plane must be enabled in the renderer project settings for this to work.enable_orthographic_tiling
(bool): [Read-Write] Render the scene in n frames (i.e TileCount) - Ignored in Perspective mode, works only in Orthographic mode when CaptureSource uses SceneColor (not FinalColor) If CaptureSource uses FinalColor, tiling will be ignored and a Warning message will be loggedfov_angle
(float): [Read-Write] Camera field of view (in degrees).hidden_actors
(Array[Actor]): [Read-Write] The actors to hide in the scene capture.hidden_in_game
(bool): [Read-Write] Whether to hide the primitive in game, if the primitive is Visible.is_editor_only
(bool): [Read-Write] If true, the component will be excluded from non-editor buildslod_distance_factor
(float): [Read-Write] Scales the distance used by LOD. Set to values greater than 1 to cause the scene capture to use lower LODs than the main view to speed up the scene capture pass.max_view_distance_override
(float): [Read-Write] if > 0, sets a maximum render distance override. Can be used to cull distant objects from a reflection if the reflecting plane is in an enclosed area like a hallway or roommobility
(ComponentMobility): [Read-Write] How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.num_x_tiles
(int32): [Read-Write] Number of X tiles to render. Ignored in Perspective mode, works only in Orthographic modenum_y_tiles
(int32): [Read-Write] Number of Y tiles to render. Ignored in Perspective mode, works only in Orthographic modeon_component_activated
(ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivatedortho_width
(float): [Read-Write] The desired width (in world units) of the orthographic view (ignored in Perspective mode)override_custom_near_clipping_plane
(bool): [Read-Write]physics_volume_changed_delegate
(PhysicsVolumeChanged): [Read-Write] Delegate that will be called when PhysicsVolume has been changed *post_process_blend_weight
(float): [Read-Write] Range (0.0, 1.0) where 0 indicates no effect, 1 indicates full effect.post_process_settings
(PostProcessSettings): [Read-Write]primary_component_tick
(ActorComponentTickFunction): [Read-Write] Main tick function for the Componentprimitive_render_mode
(SceneCapturePrimitiveRenderMode): [Read-Write] Controls what primitives get rendered into the scene capture.profiling_event_name
(str): [Read-Write] Name of the profiling event.projection_type
(CameraProjectionMode): [Read-Write]relative_location
(Vector): [Read-Write] Location of the component relative to its parentrelative_rotation
(Rotator): [Read-Write] Rotation of the component relative to its parentrelative_scale3d
(Vector): [Read-Write] Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)render_in_main_renderer
(bool): [Read-Write] Render scene capture as additional render passes of the main renderer rather than as an independent renderer. Can only apply to scene depth and device depth modes.replicate_using_registered_sub_object_list
(bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.replicates
(bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!should_update_physics_volume
(bool): [Read-Write] Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()show_flag_settings
(Array[EngineShowFlagsSetting]): [Read-Write] ShowFlags for the SceneCapture’s ViewFamily, to control rendering settings for this view. Hidden but accessible through details customizationshow_only_actors
(Array[Actor]): [Read-Write] The only actors to be rendered by this scene capture, if PrimitiveRenderMode is set to UseShowOnlyList.texture_target
(TextureRenderTarget2D): [Read-Write] Output render target of the scene capture that can be read in materials.update_ortho_planes
(bool): [Read-Write] Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefactinguse_attach_parent_bound
(bool): [Read-Write] If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.use_camera_height_as_view_target
(bool): [Read-Write] If UpdateOrthoPlanes is enabled, this setting will use the cameras current height to compensate the distance to the general view (as a pseudo distance to view target when one isn’t present)use_custom_projection_matrix
(bool): [Read-Write] Whether a custom projection matrix will be used during rendering. Use with caution. Does not currently affect cullinguse_faux_ortho_view_pos
(bool): [Read-Write] deprecated: 5.4 - bUseFauxOrthoViewPos has been deprecated alongside updates to Orthographic camera fixesuse_ray_tracing_if_enabled
(bool): [Read-Write] Whether to use ray tracing for this capture. Ray Tracing must be enabled in the project.visible
(bool): [Read-Write] Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.
- add_or_update_blendable(blendable_object, weight=1.000000) None ¶
Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn’t exist) and update the weight
- Parameters:
blendable_object (BlendableInterface) –
weight (float) –
- property auto_calculate_ortho_planes: bool¶
[Read-Write] Automatically determine a min/max Near/Far clip plane position depending on OrthoWidth value
- Type:
(bool)
- property auto_plane_shift: float¶
[Read-Write] Manually adjusts the planes of this camera, maintaining the distance between them. Positive moves out to the farplane, negative towards the near plane
- Type:
(float)
- property camera_cut_this_frame: bool¶
[Read-Write] True if we did a camera cut this frame. Automatically reset to false at every capture. This flag affects various things in the renderer (such as whether to use the occlusion queries from last frame, and motion blur). Similar to UPlayerCameraManager::bGameCameraCutThisFrame.
- Type:
(bool)
- capture_scene() None ¶
Render the scene to the texture target immediately. This should not be used if bCaptureEveryFrame is enabled, or the scene capture will render redundantly. If r.SceneCapture.CullByDetailMode is set, nothing will happen if DetailMode is higher than r.DetailMode.
- property clip_plane_base: Vector¶
[Read-Write] Base position for the clip plane, can be any position on the plane.
- Type:
(Vector)
- property composite_mode: SceneCaptureCompositeMode¶
[Read-Write] When enabled, the scene capture will composite into the render target instead of overwriting its contents.
- Type:
- property consider_unrendered_opaque_pixel_as_fully_translucent: bool¶
[Read-Write] Whether to only render exponential height fog on opaque pixels which were rendered by the scene capture.
- Type:
(bool)
- property custom_near_clipping_plane: float¶
[Read-Write] Set bOverride_CustomNearClippingPlane to true if you want to use a custom clipping plane instead of GNearClippingPlane.
- Type:
(float)
- property custom_projection_matrix: Matrix¶
[Read-Write] The custom projection matrix to use
- Type:
(Matrix)
- property enable_clip_plane: bool¶
[Read-Write] Enables a clip plane while rendering the scene capture which is useful for portals. The global clip plane must be enabled in the renderer project settings for this to work.
- Type:
(bool)
- property enable_orthographic_tiling: bool¶
[Read-Write] Render the scene in n frames (i.e TileCount) - Ignored in Perspective mode, works only in Orthographic mode when CaptureSource uses SceneColor (not FinalColor) If CaptureSource uses FinalColor, tiling will be ignored and a Warning message will be logged
- Type:
(bool)
- property num_x_tiles: int¶
[Read-Write] Number of X tiles to render. Ignored in Perspective mode, works only in Orthographic mode
- Type:
(int32)
- property num_y_tiles: int¶
[Read-Write] Number of Y tiles to render. Ignored in Perspective mode, works only in Orthographic mode
- Type:
(int32)
- property ortho_width: float¶
[Read-Write] The desired width (in world units) of the orthographic view (ignored in Perspective mode)
- Type:
(float)
- property post_process_blend_weight: float¶
[Read-Write] Range (0.0, 1.0) where 0 indicates no effect, 1 indicates full effect.
- Type:
(float)
- property post_process_settings: PostProcessSettings¶
[Read-Write]
- Type:
- property projection_type: CameraProjectionMode¶
[Read-Write]
- Type:
- remove_blendable(blendable_object) None ¶
Removes a blendable.
- Parameters:
blendable_object (BlendableInterface) –
- property render_in_main_renderer: bool¶
[Read-Write] Render scene capture as additional render passes of the main renderer rather than as an independent renderer. Can only apply to scene depth and device depth modes.
- Type:
(bool)
- property texture_target: TextureRenderTarget2D¶
[Read-Write] Output render target of the scene capture that can be read in materials.
- Type:
- property update_ortho_planes: bool¶
[Read-Write] Adjusts the near/far planes and the view origin of the current camera automatically to avoid clipping and light artefacting
- Type:
(bool)
- property use_camera_height_as_view_target: bool¶
[Read-Write] If UpdateOrthoPlanes is enabled, this setting will use the cameras current height to compensate the distance to the general view (as a pseudo distance to view target when one isn’t present)
- Type:
(bool)