ITextureShare

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

ITextureShare

References

Module

TextureShare

Header

/Engine/Plugins/Runtime/TextureShare/Source/TextureShare/Public/ITextureShare.h

Include

#include "ITextureShare.h"

Syntax

class ITextureShare : public IModuleInterface

Functions

Name Description

Public function

bool

 

CreateShare

(
    const FString& ShareName,
    const FTextureShareSyncPolicy& Syn...,
    ETextureShareProcess Process
)

Create TextureShare object

Public function Static

ITextureShar...

 

Get()

Singleton-like access to this module's interface.

Public function Const

bool

 

GetShare

(
    const FString& ShareName,
    TSharedPtr< ITextureShareItem >& O...
)

Get ITextureShareItem low-level api object

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function

bool

 

LinkSceneContextToShare

(
    const TSharedPtr< ITextureShareItem...,
    int StereoscopicPass,
    bool bIsEnabled
)

Send scene context textures from specified StereoscopicPass via share

Public function

bool

 

ReadFromShare_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    const TSharedPtr< ITextureShareItem...,
    const FString& TextureName,
    FRHITexture* DstTexture,
    const FIntRect* DstTextureRect
)

Read from shared object texture to destination texture region

Public function

bool

 

ReceiveTexture_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    const TSharedPtr< ITextureShareItem...,
    const FString& TextureName,
    FRHITexture* DstTexture,
    const FIntRect* DstTextureRect
)

Receive (and register texture if need) RHI texture from shared object texture

Public function

bool

 

RegisterTexture

(
    const TSharedPtr< ITextureShareItem...,
    const FString& InTextureName,
    const FIntPoint& InSize,
    EPixelFormat InFormat,
    ETextureShareSurfaceOp OperationTyp...
)

Register/Update texture info for share

Public function

bool

 

ReleaseShare

(
    const FString& ShareName
)

Delete TextureShare object

Public function

bool

 

SendTexture_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    const TSharedPtr< ITextureShareItem...,
    const FString& TextureName,
    FRHITexture* SrcTexture,
    const FIntRect* SrcTextureRect
)

Send (and register texture if need) RHI texture to shared object texture

Public function

bool

 

SetBackbufferRect

(
    int StereoscopicPass,
    FIntRect* BackbufferRect
)

Use this rect as backbuffer rect, for stereoscopic pass

Public function

bool

 

WriteToShare_RenderThread

(
    FRHICommandListImmediate& RHICmdLi...,
    const TSharedPtr< ITextureShareItem...,
    const FString& TextureName,
    FRHITexture* SrcTexture,
    const FIntRect* SrcTextureRect
)

Write texture region to shared object texture.

Constants

Name

Description

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