FExternalTextureRegistry Class Reference

#include <ExternalTexture.h>

Public Member Functions
ENGINE_API void	RegisterExternalTexture (const FGuid &InGuid, FTextureRHIRef &InTextureRHI, FSamplerStateRHIRef &InSamplerStateRHI, const FLinearColor &InCoordinateScaleRotation=FLinearColor(1, 0, 0, 1), const FLinearColor &InCoordinateOffset=FLinearColor(0, 0, 0, 0))
ENGINE_API void	UnregisterExternalTexture (const FGuid &InGuid)
ENGINE_API void	RemoveMaterialRenderProxyReference (const FMaterialRenderProxy *MaterialRenderProxy)
ENGINE_API bool	GetExternalTexture (const FMaterialRenderProxy *MaterialRenderProxy, const FGuid &InGuid, FTextureRHIRef &OutTextureRHI, FSamplerStateRHIRef &OutSamplerStateRHI)
ENGINE_API bool	GetExternalTextureCoordinateScaleRotation (const FGuid &InGuid, FLinearColor &OutCoordinateScaleRotation)
ENGINE_API bool	GetExternalTextureCoordinateOffset (const FGuid &InGuid, FLinearColor &OutCoordinateOffset)

Static Public Member Functions
static ENGINE_API FExternalTextureRegistry &	Get ()

Detailed Description

Stores a registry of external textures mapped to their GUIDs.

Member Function Documentation

Get()

FExternalTextureRegistry & FExternalTextureRegistry::Get ( )

static

Get the registry singleton instance.

Returns

External texture registry.

GetExternalTexture()

bool FExternalTextureRegistry::GetExternalTexture	(	const FMaterialRenderProxy *	MaterialRenderProxy,
		const FGuid &	InGuid,
		FTextureRHIRef &	OutTextureRHI,
		FSamplerStateRHIRef &	OutSamplerStateRHI
	)

Get the external texture with the specified identifier.

Parameters

MaterialRenderProxy	The material render proxy that is using the texture (will be registered).
InGuid	The texture's unique identifier.
OutTextureRHI	Will contain the external texture.
OutSamplerStateRHI	Will contain the texture's sampler state.

Returns

true on success, false if the identifier was not found.

See also

RegisterExternalTexture, UnregisterExternalTexture

GetExternalTextureCoordinateOffset()

bool FExternalTextureRegistry::GetExternalTextureCoordinateOffset	(	const FGuid &	InGuid,
		FLinearColor &	OutCoordinateOffset
	)

Looks up an texture coordinate offset for given a given GUID.

Parameters

InGuid	The texture's unique identifier.
OutCoordinateOffset	Will contain the texture's coordinate offset (packed into color value).

Returns

true on success, false if the identifier was not found.

See also

GetExternalTextureCoordinateScaleRotation

GetExternalTextureCoordinateScaleRotation()

bool FExternalTextureRegistry::GetExternalTextureCoordinateScaleRotation	(	const FGuid &	InGuid,
		FLinearColor &	OutCoordinateScaleRotation
	)

Looks up an external texture's coordinate scale rotation.

Parameters

InGuid	The texture's unique identifier.
OutCoordinateScaleRotation	Will contain the texture's coordinate scale and rotation (packed into color value).

Returns

true on success, false if the identifier was not found.

See also

GetExternalTextureCoordinateOffset

RegisterExternalTexture()

void FExternalTextureRegistry::RegisterExternalTexture	(	const FGuid &	InGuid,
		FTextureRHIRef &	InTextureRHI,
		FSamplerStateRHIRef &	InSamplerStateRHI,
		const FLinearColor &	InCoordinateScaleRotation = FLinearColor(1, 0, 0, 1),
		const FLinearColor &	InCoordinateOffset = FLinearColor(0, 0, 0, 0)
	)

Register an external texture, its sampler state and coordinate scale/bias against a GUID.

Parameters

InGuid	The texture's unique identifier.
InTextureRHI	The texture.
InSamplerStateRHI	The texture's sampler state.
InCoordinateScaleRotation	Texture coordinate scale and rotation parameters (optional; packed into color value).
InCoordinateOffset	Texture coordinate offset (optional; packed into color value).

See also

GetExternalTexture, UnregisterExternalTexture

RemoveMaterialRenderProxyReference()

void FExternalTextureRegistry::RemoveMaterialRenderProxyReference

(

const FMaterialRenderProxy *

MaterialRenderProxy

)

Removes the specified MaterialRenderProxy from the list of those using an external texture.

Parameters

MaterialRenderProxy

The material render proxy to remove.

See also

GetExternalTexture, RegisterExternalTexture, UnregisterExternalTexture

UnregisterExternalTexture()

void FExternalTextureRegistry::UnregisterExternalTexture

(

const FGuid &

InGuid

)

Removes an external texture given a GUID.

Parameters

InGuid

The unique identifier of the texture to unregister.

See also

RegisterExternalTexture

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/ExternalTexture.h
• Engine/Source/Runtime/Engine/Private/ExternalTexture.cpp