UBillboardComponent | Unreal Engine 5.2 Documentation

Inheritance Hierarchy


Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/BillboardComponent.h
Include	#include "Components/BillboardComponent.h"

class UBillboardComponent : public UPrimitiveComponent

A 2d texture that will be rendered always facing the camera.

Type	Name	Description
uint32: 1	bIsScreenSizeScaled
bool	bShowLockedLocation
bool	bUseInEditorScaling	Whether to use in-editor arrow scaling (i.e. to be affected by the global arrow scale)
float	OpacityMaskRefVal	The billboard is not rendered where texture opacity < OpacityMaskRefVal
float	ScreenSize
TObjectPtr< class UTexture2D >	Sprite
FSpriteCategoryInfo	SpriteInfo	Sprite category information regarding the component
float	U
float	UL
float	V
float	VL

	Type	Name	Description
		UBillboardComponent ( const FObjectInitializer& ObjectInitializer )

Type	Name	Description
void	SetEditorScale ( float InEditorScale )	Set the scale that we use when rendering in-editor
void	SetOpacityMaskRefVal ( float RefVal )	Changed the opacity masked used by this component
void	SetSprite ( UTexture2D* NewSprite )	Change the sprite texture used by this component
void	SetSpriteAndUV ( UTexture2D* NewSprite, int32 NewU, int32 NewUL, int32 NewV, int32 NewVL )	Change the sprite texture and the UV's used by this component
void	SetUV ( int32 NewU, int32 NewUL, int32 NewV, int32 NewVL )	Change the sprite's UVs

Type	Name	Description
bool	ComponentIsTouchingSelectionBox ( const FBox& InSelBBox, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComponent )	Determines whether the supplied bounding box intersects with the component.
bool	ComponentIsTouchingSelectionFrustum ( const FConvexVolume& InFrustum, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComponent )	Determines whether the supplied frustum intersects with the component.
FPrimitiveSceneProxy *	CreateSceneProxy ()	Creates a proxy to represent the primitive to the scene manager in the rendering thread.
bool	IsShown ( const FEngineShowFlags& ShowFlags )	Would this primitive be shown with these rendering flags.

	Type	Name	Description
	FBoxSphereBounds	CalcBounds ( const FTransform& LocalToWorld )	Calculate the bounds of the component. Default behavior is a bounding box/sphere of zero size.