Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

UBillboardComponent

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

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPrimitiveComponent

UBillboardComponent

References

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

Syntax

class UBillboardComponent : public UPrimitiveComponent

Remarks

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

Variables

	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< cla...	Sprite
FSpriteCategory...	SpriteInfo	Sprite category information regarding the component
float	U
float	UL
float	V
float	VL

Constructors

	Name	Description
	UBillboardComponent ( const FObjectInitializer& ObjectIn... )

Functions

	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

Overridden from UPrimitiveComponent

	Name	Description
bool	ComponentIsTouchingSelectionBox ( const FBox& InSelBBox, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied bounding box intersects with the component.
bool	ComponentIsTouchingSelectionFrustum ( const FConvexVolume& InFrustum, const bool bConsiderOnlyBSP, const bool bMustEncompassEntireComp... )	Determines whether the supplied frustum intersects with the component.
FPrimitiveSc...	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.

Overridden from USceneComponent

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

Constants

Name	Description
EditorScale	The scale we use when rendering in-editor

Deprecated Variables

		Name	Description
	FName	SpriteCategoryName_DEPRECATED	Sprite category that the component belongs to. Value serves as a key into the localization file.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Cancel