description:
Whether the async process has completed or not
true if it completed successfully, false otherwise

code: bool IsComplete() const


description: Hidden on purpose

module: Sockets

code: FResolveInfo()


description: Virtual destructor for child classes to overload

code: virtual ~FResolveInfo()


className: FResolveInfo

description: Abstract interface used by clients to get async host name resolution to work in a cross-platform way

code: class FResolveInfo


description: Resolves the specified host name

code: void DoWork()


description:
The error that occurred when trying to resolve
error code from the operation

code: virtual int32 GetErrorCode() const


description:
Returns a copy of the resolved address
the resolved IP address

code: virtual const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GetResolvedAddress() const


code: virtual bool IsComplete() const


description: Start the async work and perform it synchronously if no thread pool is available

code: void StartAsyncTask()


description: Copies the host name for async resolution

code: FResolveInfoAsync ( const ANSICHAR * InHostName )


className: FResolveInfoAsync

description: Class for creating a background thread to resolve a host.

code: class FResolveInfoAsync : public [FResolveInfo](API\Runtime\Sockets\FResolveInfo)


description: Hidden on purpose

code: FResolveInfoCached()


description: Sets the address to return to the caller

code: FResolveInfoCached ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & InAddr )


className: FResolveInfoCached

description: A non-async resolve info for returning cached results

code: class FResolveInfoCached : public [FResolveInfo](API\Runtime\Sockets\FResolveInfo)

Addr

type: TSharedPtr<FIn...

description: The address that was resolved


description: Adds a file or directory to TOC.

code: void AddFileOrDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Filename, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Timestamp )


className: FDirectory

description: List of files in a directory.

code: typedef [TMap](API\Runtime\Core\Containers\TMap)< [FString](API\Runtime\Core\Containers\FString), [FDateTime](API\Runtime\Core\Misc\FDateTime) > FDirectory


description:
Finds a directory in TOC.
Pointer to a FDirectory if the directory was found, NULL otherwise.

code: const [FDirectory](API\Runtime\Sockets\FServerTOC\FDirectory) * FindDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Directory ) const


description:
Finds a directory in TOC non const version used internally see FindDirectory
pointer to a FDirectory if the directory was found, null otherwise

code: [FDirectory](API\Runtime\Sockets\FServerTOC\FDirectory) * FindDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Directory )


description:
Finds a file in TOC.
Pointer to a timestamp if the file was found, NULL otherwise.

code: const [FDateTime](API\Runtime\Core\Misc\FDateTime) * FindFile ( const [FString](API\Runtime\Core\Containers\FString) & Filename ) const


code: int32 RemoveFileOrDirectory ( const [FString](API\Runtime\Core\Containers\FString) & Filename )


description: Destructor. Destroys directories.

code: ~FServerTOC()


className: FServerTOC

description: Helper struct to hold and quickly access server TOC.

code: struct FServerTOC

Directories

type: TMap<FString, ...

description: This is the "TOC" of the server


description: Return the magic number for this message, also used for endian correction on the archives

code: uint32 GetMagic() const


description:
Block until we receive data from the socket
true if read is successful

code: bool Receive ( uint8 * Results, int32 Size ) const


description:
Send bytes out the socket
true if read is successful

code: bool Send ( const uint8 * Buffer, int32 Size ) const


description: Destructor

code: virtual ~FSimpleAbstractSocket()


className: FSimpleAbstractSocket

description: Simple abstraction for sockets that allowsFNFSMessageHeaderto use either an ordinary socket or a mutichannel socket

code: class FSimpleAbstractSocket


code: virtual uint32 GetMagic() const


code: virtual bool Receive ( uint8 * Results, int32 Size ) const


code: virtual bool Send ( const uint8 * Buffer, int32 Size ) const


description: Constructor

code: FSimpleAbstractSocket_FMultichannelTCPSocket ( class [FMultichannelTcpSocket](API\Runtime\Sockets\FMultichannelTcpSocket) * InSocket, uint32 InSendChannel, uint32 InReceiveChannel )


description: Multichannel socket version ofFSimpleAbstractSocket

code: class FSimpleAbstractSocket_FMultichannelTCPSocket : public [FSimpleAbstractSocket](API\Runtime\Sockets\FSimpleAbstractSocket)


description: Constructor

code: FSimpleAbstractSocket_FSocket ( class [FSocket](API\Runtime\Sockets\FSocket) * InSocket )


description: Ordinary socket version ofFSimpleAbstractSocket

code: class FSimpleAbstractSocket_FSocket : public [FSimpleAbstractSocket](API\Runtime\Sockets\FSimpleAbstractSocket)


description:
Accepts a connection that is pending.
The new (heap-allocated) socket, or nullptr if unsuccessful.

code: [FSocket](API\Runtime\Sockets\FSocket) * Accept ( const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription )


code: [FSocket](API\Runtime\Sockets\FSocket) * Accept ( [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription )


description:
Binds a socket to a network byte ordered address.
true if successful, false otherwise.

code: bool Bind ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Addr )


description:
Closes the socket
true if it closes without errors, false otherwise.

code: bool Close()


description:
Connects a socket to a network byte ordered address.
true if successful, false otherwise.

code: bool Connect ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Addr )


description: Reads the address the socket is bound to and returns it.

code: void GetAddress ( [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr )


description:
Determines the connection state of the socket.
Connection state.


description: GetSocketType


description:
Reads the address of the peer the socket is connected to.
true if the address was retrieved correctly, false otherwise.

code: bool GetPeerAddress ( [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr )


description: GetDescription

code: int32 GetPortNo()


description: GetPortNo


description: GetPortNo

code: ESocketType GetSocketType() const


description:
Queries the socket to determine if there is a pending connection.
true if successful, false otherwise.

code: bool HasPendingConnection ( bool & bHasPendingConnection )


description:
Queries the socket to determine if there is pending data on the queue.
true if the socket has data, false otherwise.

code: bool HasPendingData ( uint32 & PendingDataSize )


description: SetMulticastTtl

code: bool JoinMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress )


description: SetMulticastTtl

code: bool JoinMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress, const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & InterfaceAddress )


description: SetMulticastTtl

code: bool LeaveMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress )


description: SetMulticastTtl

code: bool LeaveMulticastGroup ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & GroupAddress, const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & InterfaceAddress )


description:
Places the socket into a state to listen for incoming connections.
true if successful, false otherwise.

code: bool Listen ( int32 MaxBacklog )


description:
A return value of 'true' does not necessarily mean that data was returned. Callers must check the 'BytesRead' parameter for the actual amount of data returned. A value of zero indicates that there was no data available for reading.
true on success, false in case of a closed socket or an unrecoverable error.

code: virtual bool Recv ( uint8 * Data, int32 BufferSize, int32 & BytesRead, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags )


code: virtual bool RecvFrom ( uint8 * Data, int32 BufferSize, int32 & BytesRead, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Source, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags )


code: virtual bool RecvFromWithPktInfo ( uint8 * Data, int32 BufferSize, int32 & BytesRead, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Source, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Destination, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags )


description: Sends a buffer on a connected socket.

code: virtual bool Send ( const uint8 * Data, int32 Count, int32 & BytesSent )


description:
Reads multiple packets from the socket at once, gathering the source address and other optional platform specific data. UseISocketSubsystem::IsSocketRecvMultiSupportedto check if the current socket platform supports this. NOTE: For optimal performance, oneFRecvMultiinstance should be used, for the lifetime of the socket.
Whether or not data was successfully received

code: virtual bool RecvMulti ( [FRecvMulti](API\Runtime\Sockets\FRecvMulti) & MultiData, [ESocketReceiveFlags::Type](API\Runtime\Sockets\ESocketReceiveFlags__Type) Flags )


description: Sends a buffer to a network byte ordered address.

code: virtual bool SendTo ( const uint8 * Data, int32 Count, int32 & BytesSent, const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Destination )


description:
Sets a socket into broadcast mode (UDP only).
true if successful, false otherwise.

code: bool SetBroadcast ( bool bAllowBroadcast )


description:
Sets whether to enable IP_PKTINFO support
True if the call succeeded, false otherwise.

code: virtual bool SetIpPktInfo ( bool bEnable )


description:
Sets whether and how long a socket will linger after closing.
true if the call succeeded, false otherwise.

code: bool SetLinger ( bool bShouldLinger, int32 Timeout )


description:
Multicast traffic is sent using the default interface, this allows to explicitly set the interface used to send outgoing multicast datagrams.
true if the call succeeded, false otherwise.

code: bool SetMulticastInterface ( const [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & InterfaceAddress )


description: SetMulticastTtl

code: bool SetMulticastLoopback ( bool bLoopback )


description: SetMulticastLoopback

code: bool SetMulticastTtl ( uint8 TimeToLive )


description:
Sets this socket into TCP_NODELAY mode (TCP only).
true if successful, false otherwise.

code: bool SetNoDelay ( bool bIsNoDelay )


description:
Sets this socket into non-blocking mode.
true if successful, false otherwise.

code: bool SetNonBlocking ( bool bIsNonBlocking )


description:
Sets the size of the receive buffer to use.
true if the call succeeded, false otherwise.

code: bool SetReceiveBufferSize ( int32 Size, int32 & NewSize )


description:
Enables error queue support for the socket.
true if the call succeeded, false otherwise.

code: bool SetRecvErr ( bool bUseErrorQueue )


description:
Sets whether to retrieve the system-level receive timestamp, for sockets
True if the call succeeded, false otherwise.

code: virtual bool SetRetrieveTimestamp ( bool bRetrieveTimestamp )


description:
Sets whether a socket can be bound to an address in use.
true if the call succeeded, false otherwise.

code: bool SetReuseAddr ( bool bAllowReuse )


description:
Sets the size of the send buffer to use.
true if the call succeeded, false otherwise.

code: bool SetSendBufferSize ( int32 Size, int32 & NewSize )


description:
Shuts down the socket, making it unusable for reads and/or writes. This does not close the socket!
true if successful, false otherwise.

code: bool Shutdown ( ESocketShutdownMode Mode )


description:
Blocks until the specified condition is met.
true if the condition was met, false if the time limit expired or an error occurred.

code: bool Wait ( [ESocketWaitConditions::Type](API\Runtime\Sockets\ESocketWaitConditions__Type) Condition, [FTimespan](API\Runtime\Core\Misc\FTimespan) WaitTime )


description:
Waits for a pending connection on the socket.
true if successful, false otherwise.

code: bool WaitForPendingConnection ( bool & bHasPendingConnection, const [FTimespan](API\Runtime\Core\Misc\FTimespan) & WaitTime )


description: Default constructor.

code: FSocket()


description: Specifies the type of socket being created

code: FSocket ( ESocketType InSocketType, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription )


description: Deprecated* Please migrate to the constructor that takes anFNamefor the protocol stack

code: FSocket ( ESocketType InSocketType, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription, ESocketProtocolFamily InSocketProtocol )


code: FSocket ( ESocketType InSocketType, const [FString](API\Runtime\Core\Containers\FString) & InSocketDescription, const [FName](API\Runtime\Core\UObject\FName) & InSocketProtocol )


description: Virtual destructor.

code: virtual ~FSocket()


className: FSocket

description: This is our abstract base class that hides the platform specific socket implementation

code: class FSocket

SocketDescription

type: FString

description: Debug description of socket usage.

SocketProtocol

type: FName

description: Protocol used in creation of a socket

SocketType

type: const ESocketTy...

description: Indicates the type of socket this is


code: void operator() ( [FSocket](API\Runtime\Sockets\FSocket) * Socket ) const


code: FSocketDeleter ( [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * InSubsystem )


description:
Main entry point for accessing a socket subsystem by name Will load the appropriate module if the subsystem isn't currently loaded It's possible that the subsystem doesn't exist and therefore can return NULL
Requested socket subsystem, or NULL if that subsystem was unable to load or doesn't exist

code: virtual [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * GetSocketSubsystem ( const [FName](API\Runtime\Core\UObject\FName) InSubsystemName )


description: Register a new socket subsystem interface with the base level factory provider

code: virtual void RegisterSocketSubsystem ( const [FName](API\Runtime\Core\UObject\FName) FactoryName, class [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * Factory, bool bMakeDefault )


description: Called right after the module DLL has been loaded and the module object has been created Overloaded to allow the default subsystem a chance to load

code: virtual void StartupModule()


description: Called before the module is unloaded, right before the module object is destroyed. Overloaded to shut down all loaded online subsystems

code: virtual void ShutdownModule()


description:
Override this to set whether your module would like cleanup on application shutdown
Whether the module supports shutdown on application exit


description:
Override this to set whether your module is allowed to be unloaded on the fly
Whether the module supports shutdown separate from the rest of the engine.

code: virtual bool SupportsDynamicReloading()


description: Unregister an existing online subsystem interface from the base level factory provider

code: virtual void UnregisterSocketSubsystem ( const [FName](API\Runtime\Core\UObject\FName) FactoryName )


className: FSocketDeleter

description: Deleter object that can be used with unique & shared pointers that store FSockets. The SocketSubsystem must be valid when the call operator is invoked!

code: class FSocketDeleter


code: virtual ~FSocketSubsystemModule()


className: FSocketSubsystemModule

description: Socket subsystem module class Wraps the loading of an socket subsystem by name and allows new services to register themselves for use

code: class FSocketSubsystemModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: Stores the ip address with the matching host name

code: void AddHostNameToCache ( const ANSICHAR * HostName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > Addr )


description:
Bind to next available port.
The bound port number, or 0 on failure

code: int32 BindNextPort ( [FSocket](API\Runtime\Sockets\FSocket) * Socket, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & Addr, int32 PortCount, int32 PortIncrement )


description: Create a properFInternetAddrrepresentation


description: Create aFInternetAddrof the desired protocol

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > CreateInternetAddr ( const [FName](API\Runtime\Core\UObject\FName) ProtocolType )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > CreateInternetAddr ( uint32 Address, uint32 Port )


description:
Create a platform specificFRecvMultirepresentation
Returns the platform specificFRecvMultiinstance

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [FRecvMulti](API\Runtime\Sockets\FRecvMulti) > CreateRecvMulti ( int32 MaxNumPackets, int32 MaxPacketSize, ERecvMultiFlags Flags )


description:
Addr address to resolve for the socket subsystem
the new resolved address or NULL if failed

code: virtual [FResolveInfoCached](API\Runtime\Sockets\FResolveInfoCached) * CreateResolveInfoCached ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > Addr ) const


description:
SocketType type of socket to create (DGram, Stream, etc)
the new socket or NULL if failed

code: virtual [FSocket](API\Runtime\Sockets\FSocket) * CreateSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, ESocketProtocolFamily ProtocolType )


code: virtual [FSocket](API\Runtime\Sockets\FSocket) * CreateSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, bool bForceUDP )


code: [FSocket](API\Runtime\Sockets\FSocket) * CreateSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, const [FName](API\Runtime\Core\UObject\FName) & ProtocolName )


code: FUniqueSocket CreateUniqueSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, bool bForceUDP )


code: FUniqueSocket CreateUniqueSocket ( const [FName](API\Runtime\Core\UObject\FName) & SocketType, const [FString](API\Runtime\Core\Containers\FString) & SocketDescription, const [FName](API\Runtime\Core\UObject\FName) & ProtocolName )


description: Cleans up a socket class

code: void DestroySocket ( [FSocket](API\Runtime\Sockets\FSocket) * Socket )


description: Get the singleton socket subsystem for the given named subsystem

code: static [ISocketSubsystem](API\Runtime\Sockets\ISocketSubsystem) * Get ( const [FName](API\Runtime\Core\UObject\FName) & SubsystemName )


description:
This is a what you see is what you get, there is no DNS resolution of the input string, so only use this if you know you already have a valid address and will not need to convert. Otherwise, feed the address to GetAddressInfo for guaranteed results.
TheFInternetAddrof the given string address. This will point to nullptr on failure.

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > GetAddressFromString ( const [FString](API\Runtime\Core\Containers\FString) & InAddress )


description:
Gets the address information of the given hostname and outputs it into an array of resolvable addresses. It is up to the caller to determine which one is valid for their environment.
the results structure containing the array of address results to this query

code: virtual [FAddressInfoResult](API\Runtime\Sockets\FAddressInfoResult) GetAddressInfo ( const TCHAR * HostName, const TCHAR * ServiceName, EAddressInfoFlags QueryFlags, ESocketProtocolFamily ProtocolType, ESocketType SocketType )


description:
This function allows for specifying FNames for the protocol type, allowing for support of other platform protocols
the results structure containing the array of address results to this query

code: [FAddressInfoResult](API\Runtime\Sockets\FAddressInfoResult) GetAddressInfo ( const TCHAR * HostName, const TCHAR * ServiceName, EAddressInfoFlags QueryFlags, const [FName](API\Runtime\Core\UObject\FName) ProtocolTypeName, ESocketType SocketType )


description: This function allows for specifying FNames for the protocol type, allowing for support of other platform protocols

code: virtual void GetAddressInfoAsync ( FAsyncGetAddressInfoCallback Callback, const TCHAR * HostName, const TCHAR * ServiceName, EAddressInfoFlags QueryFlags, const [FName](API\Runtime\Core\UObject\FName) ProtocolTypeName, ESocketType SocketType )


description:
Creates a platform specific async hostname resolution object
the resolve info to query for the address

code: virtual [FResolveInfo](API\Runtime\Sockets\FResolveInfo) * GetHostByName ( const ANSICHAR * HostName )


description:
Determines the name of the local machine
true if successful, false otherwise

code: bool GetHostName ( [FString](API\Runtime\Core\Containers\FString) & HostName )


description:
Checks the host name cache for an existing entry (faster than resolving again)
true if the host was found, false otherwise

code: bool GetHostByNameFromCache ( const ANSICHAR * HostName, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< class [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Addr )


description: Returns the last error that has happened

code: ESocketErrors GetLastErrorCode()


description:
Gets the list of addresses associated with the adapters on the local computer. Unlike GetLocalHostAddr, this function does not give preferential treatment to multihome options in results. It's encouraged that users check for multihome before using the results of this function.
true on success, false otherwise.

code: virtual bool GetLocalAdapterAddresses ( [TArray](API\Runtime\Core\Containers\TArray)< [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) >> & OutAddresses )


description: Typically, it is better to use GetLocalBindAddresses as it better supports hybrid network functionality and less chances for connections to fail due to mismatched protocols.

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > GetLocalBindAddr ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Out )


description:
Get bindable addresses that this machine can use as reported by GetAddressInfo with the BindableAddress flag. This will return the various any address for usage. If multihome has been specified, only the multihome address will be returned in the array.
If GetAddressInfo succeeded or multihome is specified, an array of addresses that can be binded on. Failure returns an empty array.

code: virtual [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > > GetLocalBindAddresses()


description:
Returns the multihome address if the flag is present and valid. For ease of use, this function will check validity of the address for the caller.
If the multihome address was set and valid

code: virtual bool GetMultihomeAddress ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > & Addr )


description:
To better support multiple network interfaces and remove ambiguity between address protocols, it is encouraged to use GetLocalAdapterAddresses to determine machine addresses. Be sure to check GetMultihomeAddress ahead of time.
The local host address

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternetAddr](API\Runtime\Sockets\FInternetAddr) > GetLocalHostAddr ( [FOutputDevice](API\Runtime\Core\Misc\FOutputDevice) & Out, bool & bCanBindAll )


description: Conversion functions from the SocketProtocolFamily enum to the newFNamesystem. For now, both are supported, but it's better to use theFNamewhen possible.

code: virtual ESocketProtocolFamily GetProtocolFamilyFromName ( const [FName](API\Runtime\Core\UObject\FName) & InProtocolName ) const


description: Does a DNS look up of a host name This code assumes a lot, and as such, it's not guaranteed that the results provided by it are correct.

code: virtual ESocketErrors GetHostByName ( const ANSICHAR * HostName, [FInternetAddr](API\Runtime\Sockets\FInternetAddr) & OutAddr )


code: virtual [FName](API\Runtime\Core\UObject\FName) GetProtocolNameFromFamily ( ESocketProtocolFamily InProtocolFamily ) const


description: Returns a human readable string from an error code

code: const TCHAR * GetSocketError ( ESocketErrors Code )


description: Whether the machine has a properly configured network device or not

code: bool HasNetworkDevice()


description:
Get the name of the socket subsystem
a string naming this subsystem

code: const TCHAR * GetSocketAPIName() const


description:
Does per platform initialization of the sockets library
true if initialized ok, false otherwise

code: bool Init ( [FString](API\Runtime\Core\Containers\FString) & Error )


description: Returns true ifFSocket::RecvFromWithPktInfois supported by this socket subsystem.

code: virtual bool IsRecvFromWithPktInfoSupported() const


description: Returns true ifFSocket::RecvMultiis supported by this socket subsystem

code: virtual bool IsSocketRecvMultiSupported() const


description: Returns true ifFSocket::Waitis supported by this socket subsystem.

code: bool IsSocketWaitSupported() const


description: Removes the host name to ip mapping from the cache

code: void RemoveHostNameFromCache ( const ANSICHAR * HostName )


description: Some platforms require chat data (voice, text, etc.) to be placed into packets in a special way. This function tells the net connection whether this is required for this platform

code: bool RequiresChatDataBeSeparate()


description: Some platforms require packets be encrypted. This function tells the net connection whether this is required for this platform

code: bool RequiresEncryptedPackets()


description: Performs platform specific socket clean up

code: void Shutdown()


description: Shutdown all registered subsystems

code: static void ShutdownAllSystems()


description: Translates the platform error code to a ESocketErrors enum

code: ESocketErrors TranslateErrorCode ( int32 Code )


description:
Converts a platform packet timestamp, into a local timestamp, or into a time delta etc.
Returns the translated timestamp or delta

code: virtual double TranslatePacketTimestamp ( const [FPacketTimestamp](API\Runtime\NetCommon\Net\Common\Packets\FPacketTimestamp) & Timestamp, ETimestampTranslation Translation )


className: ISocketSubsystem

description: This is the base interface to abstract platform specific sockets API differences.

code: class ISocketSubsystem


description: Reserved channels for the network file system over multichannel tcp.

code: namespace NFS_Channels { enum Type { Main = 100, UnsolicitedFiles = 101, Heatbeat = 102, } }


description: Message commands, these correspond to the operations of the low level file system.

code: namespace NFS_Messages { enum Type { SyncFile, DeleteFile, MoveFile, SetReadOnly, OpenRead, OpenWrite, OpenAppend, CreateDirectory, DeleteDirectory, IterateDirectory, IterateDirectoryRecursively, DeleteDirectoryRecursively, CopyFile, GetFileInfo, Read, Write, Close, Seek, SetTimeStamp, ToAbsolutePathForRead, ToAbsolutePathForWrite, ReportLocalFiles, GetFileList, Heartbeat, RecompileShaders, } }


description: Create a new version of this packet.

module: SoundFieldRendering

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket) > Duplicate() const


description: Zero out the contents of this packet.

code: virtual void Reset()


description: Read or write this packet to a byte buffer.

code: virtual void Serialize ( [FArchive](API\Runtime\Core\Serialization\FArchive) & Ar )


code: FAmbisonicsSoundfieldBuffer()


code: virtual ~FAmbisonicsSoundfieldBuffer()


description: This should return a new, identical encoding settings.

code: virtual [TUniquePtr](API\Runtime\Core\Templates\TUniquePtr)< [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy) > Duplicate() const


className: FAmbisonicsSoundfieldBuffer

code: class FAmbisonicsSoundfieldBuffer : public [ISoundfieldAudioPacket](API\Runtime\AudioExtensions\ISoundfieldAudioPacket)

AudioBuffer

description: Interleaved audio buffer for all vector parts of the ambisonics stream.

NumChannels

description: Number of channels in the Ambisonics stream.

PreviousRotation

type: FQuat

Rotation

description: This is the rotation of the ambisonics source.


description: This should return a unique This is used so that we don't call the same encode operation multiple times for a single source being sent to identical submixes.

code: virtual uint32 GetUniqueId() const


className: FAmbisonicsSoundfieldSettings

code: class FAmbisonicsSoundfieldSettings : public [ISoundfieldEncodingSettingsProxy](API\Runtime\AudioExtensions\ISoundfieldEncodingSettingsProxy)


code: void DecodeAudioToSevenOneAndDownmixToDevice ( const [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & InputData, const [FSoundfieldSpeakerPositionalData](API\Runtime\AudioExtensions\FSoundfieldSpeakerPositionalData) & OutputPositions, [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & OutputData )


code: void DecodeAudioDirectlyToDeviceOutputPositions ( const [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & InputData, const [FSoundfieldSpeakerPositionalData](API\Runtime\AudioExtensions\FSoundfieldSpeakerPositionalData) & OutputPositions, [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & OutputData )


code: static void FoaRotationInPlace ( [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InOutFrames, const float XRotDegrees, const float YRotDegrees, const float ZRotDegrees )


code: static void RotateFirstOrderAmbisonicsBed ( const [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & InputData, [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & OutputData, const FQuat & DestinationRotation, const FQuat & PreviousRotation )


code: static const VectorRegister Sqrt2Over2Vec = MakeVectorRegister(0.707f, 0.707f, 0.707f, 0.707f);


className: VirtualSpeakerLocationsHorzOnly

code: static [TArray](API\Runtime\Core\Containers\TArray)< [Audio::FChannelPositionInfo](API\Runtime\AudioExtensions\FChannelPositionInfo) > VirtualSpeakerLocationsHorzOnly = { {EAudioMixerChannel::FrontLeft, 330, 0} ,{EAudioMixerChannel::FrontRight, 30, 0} ,{EAudioMixerChannel::FrontCenter, 0, 0} ,{EAudioMixerChannel::LowFrequency, -1, 0} ,{EAudioMixerChannel::BackLeft, 210, 0} ,{EAudioMixerChannel::BackRight, 150, 0} ,{EAudioMixerChannel::SideLeft, 250, 0} ,{EAudioMixerChannel::SideRight, 110, 0} ,{EAudioMixerChannel::BackCenter, 180,0} };


className: ZeroVec

code: static const VectorRegister ZeroVec = VectorZero();


className: FSoundFieldDecoder

code: class FSoundFieldDecoder


code: void EncodeAudioDirectlyFromOutputPositions ( const [Audio::FAlignedFloatBuffer](API\Runtime\SignalProcessing\DSP\FAlignedFloatBuffer) & InputData, const [FSoundfieldSpeakerPositionalData](API\Runtime\AudioExtensions\FSoundfieldSpeakerPositionalData) & InputPositions, const [FAmbisonicsSoundfieldSettings](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldSettings) & Settings, [FAmbisonicsSoundfieldBuffer](API\Runtime\SoundFieldRendering\FAmbisonicsSoundfieldBuffer) & OutputData )


className: FSoundFieldEncoder

code: class FSoundFieldEncoder


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


className: FSoundFieldRenderingModule

code: class FSoundFieldRenderingModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


code: static void AdjustUESphericalCoordinatesForAmbisonics ( FVector2D & InOutVector )


code: static void ComputeSoundfieldChannelGains ( const int32 Order, const float Azimuth, const float Elevation, float * OutGains )


code: static void GenerateFirstOrderRotationMatrixGivenRadians ( const float RotXRadians, const float RotYRadians, const float RotZRadians, FMatrix & OutMatrix )


code: static void GenerateFirstOrderRotationMatrixGivenDegrees ( const float RotXDegrees, const float RotYDegrees, const float RotZDegrees, FMatrix & OutMatrix )


className: FSphericalHarmonicCalculator

description: Azimuth angle is measured CCW from front. Elevation is 0 horizontal plane, + is above horizontal plane

code: class FSphericalHarmonicCalculator


description:
Accessor for the SSL certificate manager
SSL certificate manager manager

module: SSL


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

code: static [FSslModule](API\Runtime\SSL\FSslModule) & Get()


className: Singleton

description: Singleton for the module while loaded and available

code: static [FSslModule](API\Runtime\SSL\FSslModule) * Singleton = NULL;


description: Constructor

code: FSslModule()


className: FSslModule

description: Module for SSL/TLS certificate management

code: class FSslModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


className: FCertInfo

code: struct FCertInfo

KeyDigest

type: TArray< uint8, ...


className: FVerifySslCertificates

code: typedef TBaseDelegate_TwoParams< bool, const [FString](API\Runtime\Core\Containers\FString) &, const [TArray](API\Runtime\Core\Containers\TArray)< [FCertInfo](API\Runtime\SSL\Interfaces\FSslCertificateDelegates\FCertInfo) > & > FVerifySslCertificates


className: FSslCertificateDelegates

code: class FSslCertificateDelegates


className: FSslContextCreateOptions

description: Options for creating an SSL context using FSslManager::CreateSslContext

code: struct FSslContextCreateOptions

bAddCertificates

type: bool

description: Automatically add certificates from the certificate manager?

bAllowCompression

description: Do we want to allow compression?

MaximumProtocol

type: ESslTlsProtocol

description: Maximum version of SSL/TLS to allow

MinimumProtocol

description: Minimum version of SSL/TLS to allow


description: Add trusted root certificates to the SSL context

code: void AddCertificatesToSslContext ( SSL_CTX * SslContextPtr ) const


description: Clear all pinned keys

code: void ClearAllPinnedPublicKeys()


description: true if certificates are available

code: bool HasCertificatesAvailable() const


description: Check if keys have been pinned yet

code: bool HasPinnedPublicKeys() const


description: Check if the domain is currently pinned

code: bool IsDomainPinned ( const [FString](API\Runtime\Core\Containers\FString) & Domain )


code: static constexpr int PUBLIC_KEY_DIGEST_SIZE = 32;


description: Set digests for pinned certificate public key for a domain

code: void SetPinnedPublicKeys ( const [FString](API\Runtime\Core\Containers\FString) & Domain, const [FString](API\Runtime\Core\Containers\FString) & PinnedKeyDigests )


description:
Performs additional ssl validation (certificate pinning)
false if validation fails

code: bool VerifySslCertificates ( X509_STORE_CTX * Context, const [FString](API\Runtime\Core\Containers\FString) & Domain ) const


code: bool VerifySslCertificates ( [TArray](API\Runtime\Core\Containers\TArray)< [TArray](API\Runtime\Core\Containers\TArray)< uint8, [TFixedAllocator](API\Runtime\Core\Containers\TFixedAllocator)< PUBLIC_KEY_DIGEST_SIZE >>> & Digests, const [FString](API\Runtime\Core\Containers\FString) & Domain ) const


className: ISslCertificateManager

code: class ISslCertificateManager


description:
Create an SSL context
an SSL context, may be null if an error occurred

code: SSL_CTX * CreateSslContext ( const [FSslContextCreateOptions](API\Runtime\SSL\Interfaces\FSslContextCreateOptions) & CreateOptions )


description: Destroy an SSL context

code: void DestroySslContext ( SSL_CTX * SslContext )


description:
Initialize the ssl library. Can be called multiple times (may not do anything beyond first call). ShutdownSsl must be called once for each call to InitializeSsl
true if ssl was successfully initialized, false if not

code: bool InitializeSsl()


description: Shutdown the ssl library. Must be called once per call to InitializeSsl

code: void ShutdownSsl()


description: Destructor

code: virtual ~ISslManager()


className: ISslManager

description: Manager of the ssl library

code: class ISslManager


description: Method to override if a detailed description is desired in the monitor event viewer

module: StageDataCore

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString() const


code: FAssetLoadingStateProviderMessage()


code: FAssetLoadingStateProviderMessage ( EStageLoadingState InState, const [FString](API\Runtime\Core\Containers\FString) & InAssetName )


className: FAssetLoadingStateProviderMessage

description: Message sent to indicate that the node has entered or exited a loading state.

code: struct FAssetLoadingStateProviderMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)

AssetName

description: Name of the asset currently loading.

LoadingState

type: EStageLoadingSt...

description: Event for this critical state


code: FCriticalStateProviderMessage()


className: FCriticalStateProviderMessage

description: Message sent to notify about critical state change.

code: struct FCriticalStateProviderMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)

SourceName

description: Source of the critical state. i.e. TakeName, CustomRecorder, etc...

State

type: EStageCriticalS...

description: Event for this critical state


code: virtual ~FStageDataBaseMessage()


className: FStageInstanceDescriptor

description: Holds descriptive information about that data providers. Information that won't change for a session Used when monitor and provider connects

code: struct FStageInstanceDescriptor

FriendlyName

description: Friendly name for this Unreal instance. If empty, this will be MachineName - ProcessId

MachineName

description: Machine name read from FPlatformProcess::ComputerName()

ProcessId

description: ProcessId read from FPlatformProcess::GetCurrentProcessId

RolesStringified

description: Simple stringified view of the roles of that instance

SessionId

description: Session Id that may be used to differentiate different sessions on the network


className: FStageDataBaseMessage

description: Base structure for all stage monitoring messages

code: struct FStageDataBaseMessage

Identifier

type: FGuid

description: Identifier of this instance

StageMessageVersion

description: Provision for versioning if we need to differentiate version of messages.


className: FStageMonitorBaseMessage

description: Monitor only messages - listened by providers Base structure for all monitor messages

code: struct FStageMonitorBaseMessage : public [FStageDataBaseMessage](API\Runtime\StageDataCore\FStageDataBaseMessage)


className: FStageMonitorCloseMessage

description: Message sent when monitor is going down to let know linked providers

code: struct FStageMonitorCloseMessage : public [FStageMonitorBaseMessage](API\Runtime\StageDataCore\FStageMonitorBaseMessage)


code: FCriticalStateProviderMessage ( EStageCriticalStateEvent InEvent, [FName](API\Runtime\Core\UObject\FName) InSourceName )


className: FStageProviderCloseMessage

description: Message sent by Providers to notify monitors they are closing down

code: struct FStageProviderCloseMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)


code: FStageProviderDiscoveryMessage()


code: FStageProviderDiscoveryMessage ( [FStageInstanceDescriptor](API\Runtime\StageDataCore\FStageInstanceDescriptor) && InDescriptor )


className: FStageProviderDiscoveryMessage

description: Message broadcasted periodically by the monitor to discover new providers

code: struct FStageProviderDiscoveryMessage : public [FStageMonitorBaseMessage](API\Runtime\StageDataCore\FStageMonitorBaseMessage)

Descriptor

type: FStageInstanceD...

description: Detailed description of that monitor


code: FStageProviderDiscoveryResponseMessage ( [FStageInstanceDescriptor](API\Runtime\StageDataCore\FStageInstanceDescriptor) && InDescriptor )


className: FStageProviderDiscoveryResponseMessage

description: Response to a received discovery message sent by providers

code: struct FStageProviderDiscoveryResponseMessage : public [FStageProviderEventMessage](API\Runtime\StageDataCore\FStageProviderEventMessage)

description: Detailed description of that provider


description: Method to override if a detailed description is desired in the monitor event viewer

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString() const


className: FStageProviderEventMessage

description: Base Provider messages that are events

code: struct FStageProviderEventMessage : public [FStageProviderMessage](API\Runtime\StageDataCore\FStageProviderMessage)


className: FStageProviderMessage

description: Base Provider messages listened by monitors

code: struct FStageProviderMessage : public [FStageDataBaseMessage](API\Runtime\StageDataCore\FStageDataBaseMessage)

DateTime

type: FDateTime

description: DateTime of the sender. Used to keep track of messages order through Timecode rollover.

FrameTime

type: FQualifiedFrame...

description: FrameTime of the sender.


className: FStageProviderPeriodicMessage

description: Base Provider messages that are periodic

code: struct FStageProviderPeriodicMessage : public [FStageProviderMessage](API\Runtime\StageDataCore\FStageProviderMessage)


className: ModularFeatureName

description: Name of the DataProvider modular feature

code: static [FName](API\Runtime\Core\UObject\FName) ModularFeatureName = "ModularFeature_StageDataProvider";


description: Generic send message to support constructor parameters directly and temp object created

code: template<typename MessageType, typename... Args> static bool SendMessage ( EStageMessageFlags Flags, Args &&... args )


description: Specialized send message for lvalue type without a temp object

code: template<typename MessageType, typename... Args> static bool SendMessage ( EStageMessageFlags Flags, MessageType & Message )


description: Specialized send message for rvalue type without a temp object

code: template<typename MessageType, typename... Args> static bool SendMessage ( EStageMessageFlags Flags, MessageType && Message )


description: Internal method where all send messages are funneled before being sent to the data provider instance

code: template<typename MessageType> static bool SendMessage &40; MessageType && Message, EStageMessageFlags InFlags &41;


description: Method to actually send message from a data provider to monitors

code: bool SendMessageInternal ( [FStageDataBaseMessage](API\Runtime\StageDataCore\FStageDataBaseMessage) * Payload, [UScriptStruct](API\Runtime\CoreUObject\UObject\UScriptStruct) * Type, EStageMessageFlags InFlags )


code: virtual ~IStageDataProvider()


className: IStageDataProvider

description: Interface for the data provider modular feature used in engine. Also contains methods for modules that would like to send data about stage status

code: class IStageDataProvider : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)


description: Deprecated* This attribute is no longer supported, please remove code pertaining to it.

module: StaticMeshDescription

code: TEdgeAttributesRef< float > GetEdgeCreaseSharpnesses()


code: TEdgeAttributesConstRef< float > GetEdgeCreaseSharpnesses() const


code: TEdgeAttributesRef< bool > GetEdgeHardnesses()


code: TEdgeAttributesConstRef< bool > GetEdgeHardnesses() const


code: TPolygonAttributesRef< FVector3f > GetPolygonBinormals()


code: TPolygonAttributesConstRef< FVector3f > GetPolygonBinormals() const


code: TPolygonAttributesRef< FVector3f > GetPolygonCenters()


code: TPolygonAttributesConstRef< FVector3f > GetPolygonCenters() const


code: TPolygonGroupAttributesRef< [FName](API\Runtime\Core\UObject\FName) > GetPolygonGroupMaterialSlotNames()


code: TPolygonGroupAttributesConstRef< [FName](API\Runtime\Core\UObject\FName) > GetPolygonGroupMaterialSlotNames() const


code: TPolygonAttributesRef< FVector3f > GetPolygonNormals()


code: TPolygonAttributesConstRef< FVector3f > GetPolygonNormals() const


code: TPolygonAttributesRef< FVector3f > GetPolygonTangents()


code: TPolygonAttributesConstRef< FVector3f > GetPolygonTangents() const


code: TTriangleAttributesRef< FVector3f > GetTriangleBinormals()


code: TTriangleAttributesConstRef< FVector3f > GetTriangleBinormals() const


code: TTriangleAttributesRef< FVector3f > GetTriangleNormals()


code: TTriangleAttributesConstRef< FVector3f > GetTriangleNormals() const


code: TTriangleAttributesRef< FVector3f > GetTriangleTangents()


code: TTriangleAttributesConstRef< FVector3f > GetTriangleTangents() const


code: TVertexAttributesRef< float > GetVertexCornerSharpnesses()


code: TVertexAttributesConstRef< float > GetVertexCornerSharpnesses() const


code: TVertexInstanceAttributesRef< float > GetVertexInstanceBinormalSigns()


code: TVertexInstanceAttributesConstRef< float > GetVertexInstanceBinormalSigns() const


code: TVertexInstanceAttributesRef< FVector4f > GetVertexInstanceColors()


code: TVertexInstanceAttributesConstRef< FVector4f > GetVertexInstanceColors() const


code: TVertexInstanceAttributesRef< FVector3f > GetVertexInstanceNormals()


code: TVertexInstanceAttributesConstRef< FVector3f > GetVertexInstanceNormals() const


code: TVertexInstanceAttributesRef< FVector3f > GetVertexInstanceTangents()


code: TVertexInstanceAttributesConstRef< FVector3f > GetVertexInstanceTangents() const


code: TVertexInstanceAttributesRef< FVector2f > GetVertexInstanceUVs()


code: TVertexInstanceAttributesConstRef< FVector2f > GetVertexInstanceUVs() const


code: static bool IsReservedAttributeName ( const [FName](API\Runtime\Core\UObject\FName) InAttributeName )


code: virtual void Register ( bool bKeepExistingAttribute )


description: Deprecated* Please useRegisterTriangleNormalAndTangentAttributes()instead.


code: FStaticMeshAttributes ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & InMeshDescription )


className: FStaticMeshAttributes

code: class FStaticMeshAttributes : public [FMeshAttributes](API\Runtime\MeshDescription\FMeshAttributes)


code: TEdgeAttributesConstRef< float > GetEdgeCreaseSharpnesses() const


code: TEdgeAttributesConstRef< bool > GetEdgeHardnesses() const


code: TPolygonAttributesConstRef< FVector3f > GetPolygonBinormals() const


code: TPolygonAttributesConstRef< FVector3f > GetPolygonCenters() const


code: TPolygonGroupAttributesConstRef< [FName](API\Runtime\Core\UObject\FName) > GetPolygonGroupMaterialSlotNames() const


code: TPolygonAttributesConstRef< FVector3f > GetPolygonNormals() const


code: TTriangleAttributesConstRef< FVector3f > GetTriangleBinormals() const


code: TTriangleAttributesConstRef< FVector3f > GetTriangleNormals() const


code: TPolygonAttributesConstRef< FVector3f > GetPolygonTangents() const


code: TVertexAttributesConstRef< float > GetVertexCornerSharpnesses() const


code: TTriangleAttributesConstRef< FVector3f > GetTriangleTangents() const


code: TVertexInstanceAttributesConstRef< FVector3f > GetVertexInstanceNormals() const


code: TVertexInstanceAttributesConstRef< FVector3f > GetVertexInstanceTangents() const


code: TVertexInstanceAttributesConstRef< float > GetVertexInstanceBinormalSigns() const


code: TVertexInstanceAttributesConstRef< FVector4f > GetVertexInstanceColors() const


code: TVertexInstanceAttributesConstRef< FVector2f > GetVertexInstanceUVs() const


code: FStaticMeshConstAttributes ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & InMeshDescription )


className: FStaticMeshConstAttributes

code: class FStaticMeshConstAttributes : public [FMeshConstAttributes](API\Runtime\MeshDescription\FMeshConstAttributes)


description: Add a UV channel to the MeshDescription.

code: static bool AddUVChannel ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription )


code: static void AppendMeshDescription ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & SourceMesh, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & TargetMesh, [FAppendSettings](API\Runtime\StaticMeshDescription\FStaticMeshOperations\FAppendSettings) & AppendSettings )


code: static void AppendMeshDescriptions ( const [TArray](API\Runtime\Core\Containers\TArray)< const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) * > & SourceMeshes, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & TargetMesh, [FAppendSettings](API\Runtime\StaticMeshDescription\FStaticMeshOperations\FAppendSettings) & AppendSettings )


description: Transforms the MeshDescription data using the provided transform.

code: static void ApplyTransform ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, const FTransform & Transform )


code: static void AreNormalsAndTangentsValid ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, bool & bHasInvalidNormals, bool & bHasInvalidTangents )


description: Compute tangent and Bi-Normal using mikkt space for every vertex in the mesh description.

code: static void ComputeMikktTangents ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, bool bIgnoreDegenerateTriangles )


code: static void BuildWeldedVertexIDRemap ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, const float WeldingThreshold, [TMap](API\Runtime\Core\Containers\TMap)< [FVertexID](API\Runtime\MeshDescription\FVertexID), [FVertexID](API\Runtime\MeshDescription\FVertexID) > & OutVertexIDRemap )


description: Set the polygon tangent, normal, binormal and polygonCenter for all polygons in the mesh description.

code: static void ComputePolygonTangentsAndNormals ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, float ComparisonThreshold )


description: Computes the SHA hash of all the attributes values in the MeshDescription.

code: static [FSHAHash](API\Runtime\Core\Misc\FSHAHash) ComputeSHAHash ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, bool bSkipTransientAttributes )


code: static void ApplyTransform ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, const FMatrix & Transform )


description: Recompute any invalid normal, tangent or Bi-Normal for every vertex in the mesh description with the given options. If the EComputeNTBsFlags Normals or Tangents are set, the corresponding data will be force-recomputed.

code: static void ComputeTangentsAndNormals ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, EComputeNTBsFlags ComputeNTBsOptions )


description: Set the triangle tangent, normal, binormal and triangleCenter for all triangles in the mesh description.

code: static void ComputeTriangleTangentsAndNormals ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, float ComparisonThreshold, const TCHAR * DebugName )


description: Convert oldFRawMeshformat to MeshDescription.

code: static void ConvertFromRawMesh ( const [FRawMesh](API\Runtime\RawMesh\FRawMesh) & SourceRawMesh, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & DestinationMeshDescription, const [TMap](API\Runtime\Core\Containers\TMap)< int32, [FName](API\Runtime\Core\UObject\FName) > & MaterialMap, bool bSkipNormalsAndTangents, const TCHAR * DebugName )


code: static void ConvertHardEdgesToSmoothGroup ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & SourceMeshDescription, [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & FaceSmoothingMasks )


description: Convert this mesh description into the oldFRawMeshformat.

code: static void ConvertToRawMesh ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & SourceMeshDescription, [FRawMesh](API\Runtime\RawMesh\FRawMesh) & DestinationRawMesh, const [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), int32 > & MaterialMap )


code: static void ConvertSmoothGroupToHardEdges ( const [TArray](API\Runtime\Core\Containers\TArray)< uint32 > & FaceSmoothingMasks, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & DestinationMeshDescription )


description:
If the given minimum resolution is not enough to handle all the charts, generation will fail.
UV layout correctly generated

code: static bool CreateLightMapUVLayout ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, int32 SrcLightmapIndex, int32 DstLightmapIndex, int32 MinLightmapResolution, ELightmapUVVersion LightmapUVVersion, const [FOverlappingCorners](API\Runtime\MeshUtilitiesCommon\FOverlappingCorners) & OverlappingCorners )


description: Determine the edge hardnesses from existing normals

code: static void DetermineEdgeHardnessesFromVertexInstanceNormals ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, float Tolerance )


code: enum &123; MAX_NUM_UV_CHANNELS = 8 &125;


className: FAppendSettings

code: struct FAppendSettings

MergedAssetPivot

type: FVector

MeshTransform

type: TOptional< FTra...

PolygonGroupsDelegate

type: FAppendPolygonG...


description: Find all overlapping vertex using the threshold in the mesh description.

code: static void FindOverlappingCorners ( [FOverlappingCorners](API\Runtime\MeshUtilitiesCommon\FOverlappingCorners) & OverlappingCorners, const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, float ComparisonThreshold )


description: Flip the facing for a set of input polygons.

code: static void FlipPolygons ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription )


description: Generate box UV mapping for the MeshDescription

code: static void GenerateBoxUV ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, const [FUVMapParameters](API\Runtime\StaticMeshDescription\FUVMapParameters) & Params, [TMap](API\Runtime\Core\Containers\TMap)< [FVertexInstanceID](API\Runtime\MeshDescription\FVertexInstanceID), FVector2D > & OutTexCoords )


description: Generate cylindrical UV mapping for the MeshDescription

code: static void GenerateCylindricalUV ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, const [FUVMapParameters](API\Runtime\StaticMeshDescription\FUVMapParameters) & Params, [TMap](API\Runtime\Core\Containers\TMap)< [FVertexInstanceID](API\Runtime\MeshDescription\FVertexInstanceID), FVector2D > & OutTexCoords )


description: Generate planar UV mapping for the MeshDescription

code: static void GeneratePlanarUV ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, const [FUVMapParameters](API\Runtime\StaticMeshDescription\FUVMapParameters) & Params, [TMap](API\Runtime\Core\Containers\TMap)< [FVertexInstanceID](API\Runtime\MeshDescription\FVertexInstanceID), FVector2D > & OutTexCoords )


description: Create some UVs from the specified mesh description data.

code: static bool GenerateUniqueUVsForStaticMesh ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, int32 TextureResolution, bool bMergeIdenticalMaterials, [TArray](API\Runtime\Core\Containers\TArray)< FVector2D > & OutTexCoords )


description: Return the number of unique vertices, unique vertices are the result of welding all similar vertex instances (position, UV, tangent space, color,...)

code: static int32 GetUniqueVertexCount ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription )


code: static int32 GetUniqueVertexCount ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, const [FOverlappingCorners](API\Runtime\MeshUtilitiesCommon\FOverlappingCorners) & OverlappingCorners )


description: Find all charts in the mesh description.

code: static int32 GetUVChartCount ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, int32 SrcLightmapIndex, ELightmapUVVersion LightmapUVVersion, const [FOverlappingCorners](API\Runtime\MeshUtilitiesCommon\FOverlappingCorners) & OverlappingCorners )


code: static bool HasVertexColor ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription )


description: Insert a UV channel at the given index to the MeshDescription.

code: static bool InsertUVChannel ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, int32 UVChannelIndex )


description: Make sure all normals and tangents are valid. If not, recompute them.

code: static void RecomputeNormalsAndTangentsIfNeeded ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, EComputeNTBsFlags ComputeNTBsOptions )


description: Remove the UV channel at the given index from the MeshDescription.

code: static bool RemoveUVChannel ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, int32 UVChannelIndex )


description: Note: The material count MUST be the same for both the source and the destination. It will not reorder anything if the count is different.

code: static void ReorderMeshDescriptionPolygonGroups ( const [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & SourceMeshDescription, [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & DestinationMeshDescription, [TOptional](API\Runtime\Core\IO\TOptional)< const [FString](API\Runtime\Core\Containers\FString) > UnmatchMaterialNameWarning, [TOptional](API\Runtime\Core\IO\TOptional)< const [FString](API\Runtime\Core\Containers\FString) > DestinationPolygonGroupCountDifferFromSource_Msg )


description: Move some polygon to a newPolygonGroup(section)SectionIndex: The target section we want to assign the polygon. See bRemoveEmptyPolygonGroup to know how its used TriangleIndexStart: The triangle index is compute as follow: foreach polygon {TriangleIndex += Polygon->NumberTriangles} TriangleIndexEnd: The triangle index is compute as follow: foreach polygon {TriangleIndex += Polygon->NumberTriangles} bRemoveEmptyPolygonGroup: If true, any polygonGroup that is empty after moving a polygon will be delete. This parameter impact how SectionIndex is use If param is true : PolygonGroupTargetID.GetValue() do not necessary equal SectionIndex in case there is less sections then SectionIndex If param is false : PolygonGroupTargetID.GetValue() equal SectionIndex, we will add all necessary missing PolygonGroupID (this can generate empty PolygonGroupID)

code: static void SwapPolygonPolygonGroup ( [FMeshDescription](API\Runtime\MeshDescription\FMeshDescription) & MeshDescription, int32 SectionIndex, int32 TriangleIndexStart, int32 TriangleIndexEnd, bool bRemoveEmptyPolygonGroup )


className: FStaticMeshOperations

code: class FStaticMeshOperations


code: FUVMapParameters ( const FVector & InPosition, const FQuat & InRotation, const FVector & InSize, const FVector & InScale, const FVector2D & InUVTile )


description: Default settings

code: FUVMapParameters()


className: FUVMapParameters

code: struct FUVMapParameters

Position

description: Position of the UV mapping gizmo

Rotation

description: Rotation of the UV mapping gizmo (angles in degrees)

Scale

description: Scale of the UV mapping gizmo

Size

description: Length, width, height of the UV mapping gizmo

UVTile

description: Tiling of the UV mapping


description: Default settings

code: FUVMapSettings()


className: FUVMapSettings

description: UV map generation settings that are exposed to the user for scripting and through the editor

code: struct FUVMapSettings

Position

description: Position of the UV mapping gizmo

Rotation

type: FRotator

Scale

description: Scale of the UV mapping gizmo

description: Tiling of the UV mapping


code: void CreateCube ( FVector Center, FVector HalfExtents, [FPolygonGroupID](API\Runtime\MeshDescription\FPolygonGroupID) PolygonGroup, [FPolygonID](API\Runtime\MeshDescription\FPolygonID) & PolygonID_PlusX, [FPolygonID](API\Runtime\MeshDescription\FPolygonID) & PolygonID_MinusX, [FPolygonID](API\Runtime\MeshDescription\FPolygonID) & PolygonID_PlusY, [FPolygonID](API\Runtime\MeshDescription\FPolygonID) & PolygonID_MinusY, [FPolygonID](API\Runtime\MeshDescription\FPolygonID) & PolygonID_PlusZ, [FPolygonID](API\Runtime\MeshDescription\FPolygonID) & PolygonID_MinusZ )


description: Deprecated* This attribute is no longer supported, please remove code pertaining to it.

code: TEdgeAttributesRef< float > GetEdgeCreaseSharpnesses()


code: TEdgeAttributesConstRef< float > GetEdgeCreaseSharpnesses() const


code: TEdgeAttributesRef< bool > GetEdgeHardnesses()


code: TEdgeAttributesConstRef< bool > GetEdgeHardnesses() const


code: TPolygonGroupAttributesRef< [FName](API\Runtime\Core\UObject\FName) > GetPolygonGroupMaterialSlotNames()


code: TPolygonGroupAttributesConstRef< [FName](API\Runtime\Core\UObject\FName) > GetPolygonGroupMaterialSlotNames() const


code: virtual const [FStaticMeshAttributes](API\Runtime\StaticMeshDescription\FStaticMeshAttributes) & GetRequiredAttributes() const


code: virtual [FStaticMeshAttributes](API\Runtime\StaticMeshDescription\FStaticMeshAttributes) & GetRequiredAttributes()


code: TVertexAttributesRef< float > GetVertexCornerSharpnesses()


code: TVertexInstanceAttributesRef< FVector3f > GetVertexInstanceTangents()


code: TVertexAttributesConstRef< float > GetVertexCornerSharpnesses() const


code: TVertexInstanceAttributesConstRef< FVector3f > GetVertexInstanceTangents() const


code: TVertexInstanceAttributesRef< float > GetVertexInstanceBinormalSigns()


code: TVertexInstanceAttributesConstRef< float > GetVertexInstanceBinormalSigns() const


code: TVertexInstanceAttributesRef< FVector4f > GetVertexInstanceColors()


code: TVertexInstanceAttributesConstRef< FVector4f > GetVertexInstanceColors() const


code: TVertexInstanceAttributesConstRef< FVector3f > GetVertexInstanceNormals() const


code: FVector2D GetVertexInstanceUV ( [FVertexInstanceID](API\Runtime\MeshDescription\FVertexInstanceID) VertexInstanceID, int32 UVIndex ) const


code: TVertexInstanceAttributesRef< FVector2f > GetVertexInstanceUVs()


code: TVertexInstanceAttributesConstRef< FVector2f > GetVertexInstanceUVs() const


code: TVertexInstanceAttributesRef< FVector3f > GetVertexInstanceNormals()


description: Register attributes required by static mesh description

code: virtual void RegisterAttributes()


code: void SetPolygonGroupMaterialSlotName ( [FPolygonGroupID](API\Runtime\MeshDescription\FPolygonGroupID) PolygonGroupID, const [FName](API\Runtime\Core\UObject\FName) & SlotName )


code: void SetVertexInstanceUV ( [FVertexInstanceID](API\Runtime\MeshDescription\FVertexInstanceID) VertexInstanceID, FVector2D UV, int32 UVIndex )


className: UStaticMeshDescription

description: A wrapper for MeshDescription, customized for static meshes

code: class UStaticMeshDescription : public [UMeshDescriptionBase](API\Runtime\MeshDescription\UMeshDescriptionBase)


module: StorageServerClient

code: [FStorageServerChunkBatchRequest](API\Runtime\StorageServerClient\FStorageServerChunkBatchRequest) & AddChunk ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId, int64 Offset, int64 Size )


code: bool Issue ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void(uint32 ChunkCount, uint32 *ChunkIndices, uint64 *ChunkSizes, [FStorageServerResponse](API\Runtime\StorageServerClient\FStorageServerResponse) &ChunkDataStream)> OnResponse )


className: FStorageServerChunkBatchRequest

description: No constructors are accessible with public or protected access.

code: class FStorageServerChunkBatchRequest : private [FStorageServerRequest](API\Runtime\StorageServerClient\FStorageServerRequest)


code: int64 ChunkSizeRequest ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId )


code: void FileManifestRequest ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([FIoChunkId](API\Runtime\Core\IO\FIoChunkId) Id, FStringViewPath)> Callback )


code: bool Initialize ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FString](API\Runtime\Core\Containers\FString) > HostAddresses, int32 Port, const TCHAR * ProjectNameOverride, const TCHAR * PlatformNameOverride )


code: void PackageStoreRequest ( [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([FPackageStoreEntryResource](API\Runtime\Core\IO\FPackageStoreEntryResource) &&)> Callback )


code: bool ReadChunkRequest ( const [FIoChunkId](API\Runtime\Core\IO\FIoChunkId) & ChunkId, uint64 Offset, uint64 Size, [TFunctionRef](API\Runtime\Core\GenericPlatform\TFunctionRef)< void([FStorageServerResponse](API\Runtime\StorageServerClient\FStorageServerResponse) &)> OnResponse )


code: FStorageServerConnection()


code: ~FStorageServerConnection()


code: [FSocket](API\Runtime\Sockets\FSocket) * Send ( [FStorageServerConnection](API\Runtime\StorageServerClient\FStorageServerConnection) & Owner )


className: FStorageServerConnection

code: class FStorageServerConnection


code: virtual void Serialize ( void * V, int64 Length )


className: FStorageServerRequest

code: class FStorageServerRequest : public [FArchive](API\Runtime\Core\Serialization\FArchive)

AcceptType

type: EStorageServerC...

FStorageServerConnection

type: friend

HeaderBuffer

type: TAnsiStringBuil...


code: FStorageServerRequest ( FAnsiStringView Verb, FAnsiStringView Resource, FAnsiStringView Hostname, EStorageServerContentType Accept )


code: const int32 GetErrorCode() const


code: const [FString](API\Runtime\Core\Containers\FString) & GetErrorMessage() const


code: int64 SerializeChunk ( [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & OutChunk, void * TargetVa, uint64 RawOffset, uint64 RawSize )


code: int64 SerializeChunk ( [FStorageServerSerializationContext](API\Runtime\StorageServerClient\FStorageServerSerializationConte-) & Context, [FIoBuffer](API\Runtime\Core\IO\FIoBuffer) & OutChunk, void * TargetVa, uint64 RawOffset, uint64 RawSize )


code: int64 SerializeChunkTo ( FMutableMemoryView Memory, uint64 RawOffset )


description: Returns the current location within the backing data storage, which can possibly be passed to Seek later to restore a read/write location. If this returns -1, there is no backing data storage and Seek will not function.

code: virtual int64 Tell()


description: Returns total size of the backing data storage.

code: virtual int64 TotalSize()


code: ~FStorageServerResponse()


className: FStorageServerResponse

code: class FStorageServerResponse : public [FArchive](API\Runtime\Core\Serialization\FArchive)


className: FStorageServerSerializationContext

CompressedBuffer

type: TArray64< uint8...

Decoder

type: FCompressedBuff...


description:
Converts passed in filename to use an absolute path (for reading).
filename using absolute path

module: StreamingFile

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForRead ( const TCHAR * Filename )


description:
Converts passed in filename to use an absolute path (for writing)
filename using absolute path

code: virtual [FString](API\Runtime\Core\Containers\FString) ConvertToAbsolutePathForExternalAppForWrite ( const TCHAR * Filename )


description:
Copy a file. This will fail if the destination file already exists.
true if the file was copied sucessfully.

code: virtual bool CopyFile ( const TCHAR * To, const TCHAR * From, EPlatformFileRead ReadFlags, EPlatformFileWrite WriteFlags )


description: Create a directory and return true if the directory was created or already existed.

code: virtual bool CreateDirectory ( const TCHAR * Directory )


description: Create a directory, including any parent directories and return true if the directory was created or already existed.

code: virtual bool CreateDirectoryTree ( const TCHAR * Directory )


description: Delete a directory and return true if the directory was deleted or otherwise does not exist.

code: virtual bool DeleteDirectory ( const TCHAR * Directory )


description:
Delete all files and subdirectories in a directory, then delete the directory itself
true if the directory was deleted or did not exist.

code: virtual bool DeleteDirectoryRecursively ( const TCHAR * Directory )


description: Delete a file and return true if the file exists. Will not delete read only files.

code: virtual bool DeleteFile ( const TCHAR * Filename )


description: Return true if the directory exists.

code: virtual bool DirectoryExists ( const TCHAR * Directory )


description: Gets the platform file wrapped by this file.

code: virtual [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * GetLowerLevel()


description: Return the last access time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetAccessTimeStamp ( const TCHAR * Filename )


description: Gets this platform file type name.

code: virtual const TCHAR * GetName() const


description: Return the modification time of a file. ReturnsFDateTime::MinValue()on failure

code: virtual [FDateTime](API\Runtime\Core\Misc\FDateTime) GetTimeStamp ( const TCHAR * Filename )


code: static const TCHAR * GetTypeName()


description: Need to override whatFNetworkPlatformFiledoes here

code: virtual void InitializeAfterSetActive()


description: Return true if the file is read only.

code: virtual bool IsReadOnly ( const TCHAR * Filename )


description:
Call the Visit function of the visitor once for each file or directory in a directory tree. This function explores subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectoryRecursively ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description:
Call the Visit function of the visitor once for each file or directory in a single directory. This function does not explore subdirectories.
false if the directory did not exist or if the visitor returned false.

code: virtual bool IterateDirectory ( const TCHAR * Directory, [IPlatformFile::FDirectoryVisitor](API\Runtime\Core\GenericPlatform\IPlatformFile\FDirectoryVisitor) & Visitor )


description: Attempt to move a file. Return true if successful. Will not overwrite existing files.

code: virtual bool MoveFile ( const TCHAR * To, const TCHAR * From )


description:
Attempt to open a file for reading.
If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenRead ( const TCHAR * Filename, bool bAllowWrite )


description: Attempt to open a file for writing. If successful will return a non-nullptr pointer. Close the file by delete'ing the handle.

code: virtual [IFileHandle](API\Runtime\Core\GenericPlatform\IFileHandle) * OpenWrite ( const TCHAR * Filename, bool bAppend, bool bAllowRead )


description: Sends Close message to the server.

code: bool SendCloseMessage ( uint64 HandleId )


description: Sends Open message to the server and creates a new file handle if successful.

code: FStreamingNetworkFileHandle * SendOpenMessage ( const [FString](API\Runtime\Core\Containers\FString) & Filename, bool bIsWriting, bool bAppend, bool bAllowRead )


description: Sends Read message to the server.

code: bool SendReadMessage ( uint64 HandleId, uint8 * Destination, int64 BytesToRead )


description: Sends Write message to the server.

code: bool SendWriteMessage ( uint64 HandleId, const uint8 * Source, int64 BytesToWrite )


description: Sends Seek message to the server.

code: bool SendSeekMessage ( uint64 HandleId, int64 NewPosition )


description: Sets the platform file wrapped by this file.

code: virtual void SetLowerLevel ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * NewLowerLevel )


description: Attempt to change the read only status of a file. Return true if successful.

code: virtual bool SetReadOnly ( const TCHAR * Filename, bool bNewReadOnlyValue )


description: Sets the modification time of a file

code: virtual void SetTimeStamp ( const TCHAR * Filename, [FDateTime](API\Runtime\Core\Misc\FDateTime) DateTime )


description: Checks if this platform file should be used even though it was not asked to be. i.e. pak files exist on disk so we should use a pak file

code: virtual bool ShouldBeUsed ( [IPlatformFile](API\Runtime\Core\GenericPlatform\IPlatformFile) * Inner, const TCHAR * CmdLine ) const


description: Default Constructor

code: FStreamingNetworkPlatformFile()


description: Virtual destructor


className: FStreamingNetworkPlatformFile

description: Wrapper to redirect the low level file system to a server

code: class FStreamingNetworkPlatformFile : public [FNetworkPlatformFile](API\Runtime\NetworkFile\FNetworkPlatformFile)


description: Enqueue the streaming pause to suspend rendering during blocking load.

module: StreamingPauseRendering

code: virtual void BeginStreamingPause ( class [FViewport](API\Runtime\Engine\FViewport) * Viewport )


description: Enqueue the streaming pause to resume rendering after blocking load is completed.

code: virtual void EndStreamingPause()


description: Called before the module is unloaded, right before the module object is destroyed. During normal shutdown, this is called in reverse order that modules finishStartupModule(). This means that, as long as a module references dependent modules in it'sStartupModule(), it can safely reference those dependencies inShutdownModule()as well.

code: virtual void ShutdownModule()


description: FModuleManager::Get().LoadModuleChecked(TEXT("HTTP"));

code: virtual void StartupModule()


description: Default constructor.

code: FStreamingPauseRenderingModule()


className: FStreamingPauseRenderingModule

description: Module handling default behavior for streaming pause rendering. Games can override by calling RegisterBegin/EndStreamingPauseDelegate with their own delegates.

code: class FStreamingPauseRenderingModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)

BackgroundView

type: TSharedPtr< cla...

description: Helper class to translate the RHI render target to Slate

BeginDelegate

type: FBeginStreaming...

description: Delegate providing default functionality for beginning streaming pause.

bMovieWasStarted

type: bool

description: If a movie was started by BeginStreamingPause.

EndDelegate

type: FEndStreamingPa...

description: Delegate providing default functionality for ending streaming pause.

SceneViewport

type: TSharedPtr<FSc...

description: Viewport being used to render the scene once to a target while paused

ViewportWidget

type: TSharedPtr<SVi...

description: Slate viewport widget used to draw the target


description:
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
Returns singleton instance, loading the module on demand if needed

module: SynthBenchmark

code: static [ISynthBenchmark](API\Runtime\SynthBenchmark\ISynthBenchmark) & Get()


description: Could be moved out of SynthBenchmark, it only requires the RHI, only returns valid data after the RHI started up

code: void GetRHIDisplay ( [FGPUAdpater](API\Runtime\ApplicationCore\GenericPlatform\FGPUAdpater) & Out ) const


code: void GetRHIInfo ( [FGPUAdpater](API\Runtime\ApplicationCore\GenericPlatform\FGPUAdpater) & Out, [FString](API\Runtime\Core\Containers\FString) & RHIName ) const


description:
Checks to see if this module is loaded and ready. It is only valid to callGet()ifIsAvailable()returns true.
True if the module is loaded and ready to use

code: static bool IsAvailable()


code: void Run ( [FSynthBenchmarkResults](API\Runtime\ApplicationCore\GenericPlatform\FSynthBenchmarkResults) & Out, bool bGPUBenchmark, float WorkScale ) const


className: ISynthBenchmark

description: The public interface to this module

code: class ISynthBenchmark : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


module: TelemetryUtils

code: static [FTelemetryRouter](API\Runtime\TelemetryUtils\FTelemetryRouter) & Get()


description:
Registers a delegate as callback to receive telemetry of a certain type.
a handle that can be used to unregister this sink later so it is no longer called.

code: template<typename DATA_TYPE> [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) OnTelemetry ( [TDelegate](API\Runtime\Core\Delegates\TDelegate)< void(const DATA_TYPE &)> Sink )


description:
Registers a callable object as a callback receive telemetry of a certain type.
a handle that can be used to unregister this sink later so it is no longer called.

code: template<typename DATA_TYPE, typename CALLABLE, typename> [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) OnTelemetry ( CALLABLE && Sink )


description: Removes a previously registered callback.

code: template<typename DATA_TYPE> void UnregisterTelemetrySink ( [FDelegateHandle](API\Runtime\Core\Delegates\FDelegateHandle) Handle )


description: Sends data in a type-safe manner to consumers expecting this data type.

code: template<typename DATA_TYPE> void ProvideTelemetry ( const DATA_TYPE & Data )


className: FTelemetryRouter

description: Functions are internally synchronized. Re-entrant calls to the public API during callbacks are unsupported. Data is routed on the same thread it is provided. Users should copy data and schedule tasks to execute on a specified thread if they require that.

code: class FTelemetryRouter


code: static [FTelemetryUtils](API\Runtime\TelemetryUtils\FTelemetryUtils) & Get()


description: Returns an object used for routing structured telemetry data between producers and consumers.

code: static [FTelemetryRouter](API\Runtime\TelemetryUtils\FTelemetryRouter) & GetRouter()


code: virtual ~FTelemetryUtils()


className: FTelemetryUtils

code: class FTelemetryUtils : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)


code: namespace UE { namespace Telemetry { namespace Private { template<typename DATA_TYPE> auto UE::Telemetry::Private::GetDataKeyInternal() } } }


code: namespace UE { namespace Telemetry { namespace Private { template<typename DATA_TYPE> [FGuid](API\Runtime\Core\Misc\FGuid) UE::Telemetry::Private::GetDataKey() } } }


description:
Handle callback when an asset is imported.
true if the asset was identified as normal

module: TextureUtilitiesCommon

code: namespace UE { namespace NormalMapIdentification { bool UE::NormalMapIdentification::HandleAssetPostImport ( [UTexture](API\Runtime\Engine\Engine\UTexture) * InTexture ) } }


description: Get the PNGInfill setting, with Default mapped to a concrete choice.


description: UObjectinterface

code: virtual void PostEditChangeProperty ( [FPropertyChangedEvent](API\Runtime\CoreUObject\UObject\FPropertyChangedEvent) & PropertyChangedEvent )


description: Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

code: virtual void PostInitProperties()


code: UTextureImportSettings ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )


className: UTextureImportSettings

code: class UTextureImportSettings : public [UDeveloperSettings](API\Runtime\DeveloperSettings\Engine\UDeveloperSettings)


className: Moniker

module: TimeManagement

code: static const TCHAR *const Moniker = TEXT("]");


className: FBracketEnd

code: struct FBracketEnd


code: static const TCHAR *const Moniker = TEXT("[");


className: FBracketStart

code: struct FBracketStart


className: FCommonFrameRateInfo

code: struct FCommonFrameRateInfo

Description

type: FText

FrameRate

type: FFrameRate


className: AllFrameRates

code: static const [FCommonFrameRateInfo](API\Runtime\TimeManagement\FCommonFrameRateInfo) AllFrameRates = { FCommonFrameRateInfo { FFrameRate(12, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "12 fps (animation)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_12" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "12 fps (animation)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_12_Description" )) }, FCommonFrameRateInfo { FFrameRate(15, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "15 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_15" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "15 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_15_Description" )) }, FCommonFrameRateInfo { FFrameRate(24, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "24 fps (film)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_24" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "24 fps (film)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_24_Description" )) }, FCommonFrameRateInfo { FFrameRate(25, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "25 fps (PAL/25)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_25" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "25 fps (PAL/25)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_25_Description" )) }, FCommonFrameRateInfo { FFrameRate(30, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "30 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_30" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "30 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_30_Description" )) }, FCommonFrameRateInfo { FFrameRate(48, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "48 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_48" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "48 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_48_Description" )) }, FCommonFrameRateInfo { FFrameRate(50, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "50 fps (PAL/50)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_50" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "50 fps (PAL/50)" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_50_Description" )) }, FCommonFrameRateInfo { FFrameRate(60, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "60 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_60" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "60 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_60_Description" )) }, FCommonFrameRateInfo { FFrameRate(100, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "100 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_100" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "100 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_100_Description" )) }, FCommonFrameRateInfo { FFrameRate(120, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "120 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_120" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "120 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_120_Description" )) }, FCommonFrameRateInfo { FFrameRate(240, 1), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "240 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_240" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "240 fps" ), TEXT( "CommonFrameRates" ), TEXT( "FPS_240_Description" )) }, FCommonFrameRateInfo { FFrameRate(24000, 1001), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "23.976 (NTSC/24)" ), TEXT( "CommonFrameRates" ), TEXT( "NTSC_24" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "23.976 (NTSC/24)" ), TEXT( "CommonFrameRates" ), TEXT( "NTSC_24_Description" )) }, FCommonFrameRateInfo { FFrameRate(30000, 1001), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "29.97 fps (NTSC/30)" ), TEXT( "CommonFrameRates" ), TEXT( "NTSC_30" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "29.97 fps (NTSC/30)" ), TEXT( "CommonFrameRates" ), TEXT( "NTSC_30_Description" )) }, FCommonFrameRateInfo { FFrameRate(60000, 1001), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "59.94 fps (NTSC/60)" ), TEXT( "CommonFrameRates" ), TEXT( "NTSC_60" )), FInternationalization::ForUseOnlyByLocMacroAndGraphNodeTextLiterals_CreateText(TEXT( "59.94 fps (NTSC/60)" ), TEXT( "CommonFrameRates" ), TEXT( "NTSC_60_Description" )) }, };


code: static bool Contains ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) FrameRateToCheck )


code: static const [FCommonFrameRateInfo](API\Runtime\TimeManagement\FCommonFrameRateInfo) * Find ( [FFrameRate](API\Runtime\Core\Misc\FFrameRate) InFrameRate )


code: static const [FCommonFrameRateInfo](API\Runtime\TimeManagement\FCommonFrameRateInfo) * Find ( const double InFrameRateAsDecimal, const double Tolerance )


code: static [TArrayView](API\Runtime\Core\Containers\TArrayView)< const [FCommonFrameRateInfo](API\Runtime\TimeManagement\FCommonFrameRateInfo) > GetAll()


code: typedef __underlying_type ( ECommonFrameRate )


code: static const TCHAR *const Moniker = TEXT(";");


code: void DisplayFormatChanged()


className: FCommonFrameRates

code: struct FCommonFrameRates


code: virtual [TOptional](API\Runtime\Core\IO\TOptional)< double > FromString ( const [FString](API\Runtime\Core\Containers\FString) & InString, const double & InExistingValue )


className: FDropcodeDelimiter

code: struct FDropcodeDelimiter


code: virtual int32 GetMaxFractionalDigits() const


description: Gets the minimum and maximum fractional digits.

code: virtual int32 GetMinFractionalDigits() const


description: Optional callback to broadcast when a setting in the type interface changes

code: virtual FOnSettingChanged * GetOnSettingChanged()


description: Gets the string suffix used when a stringified value represents a time between whole frames.


description: Sets the minimum and maximum fractional digits - A minimum greater than 0 will always have that many trailing zeros

code: virtual void SetMinFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & NewValue )


code: virtual void SetMaxFractionalDigits ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [TOptional](API\Runtime\Core\IO\TOptional)< int32 >> & NewValue )


description: Check whether the typed character is valid

code: virtual bool IsCharacterValid ( TCHAR InChar ) const


description: Sets the string suffix to use when a stringified value represents a time between whole frames.

code: void SetSubframeIndicator ( const [FString](API\Runtime\Core\Containers\FString) & InSubframeIndicator )


code: FFrameNumberInterface ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< EFrameNumberDisplayFormats > & InDisplayFormatAttr, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< uint8 > & InOnGetZeroPadFrameNumber, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FFrameRate](API\Runtime\Core\Misc\FFrameRate) > & InTickResolutionAttr, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FFrameRate](API\Runtime\Core\Misc\FFrameRate) > & InDisplayRateAttr )


className: FFrameNumberInterface

description: To solve this, the Spinboxes will still use double as their type, but double now means frame number and not time. A double can store the entire range of int32 (which backsFFrameNumber) without precision loss, and we can execute callbacks to find out what framerate the sequence is running at. This allows us to display in Timecode, Time or Frames and convert back and forth to double for the UI, and from double into the backingFFrameNumberfor the sequence.

code: struct FFrameNumberInterface : public [INumericTypeInterface< double >](API\Runtime\Slate\Widgets\Input\INumericTypeInterface)


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FFrameTime](API\Runtime\Core\Misc\FFrameTime), [FExpressionError](API\Runtime\Core\Misc\FExpressionError) > EvaluateFrame ( const TCHAR * InExpression, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InDisplayFrameRate, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InTickResolution, bool & OutDirectlyParsed ) const


code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FFrameTime](API\Runtime\Core\Misc\FFrameTime), [FExpressionError](API\Runtime\Core\Misc\FExpressionError) > EvaluateTime ( const TCHAR * InExpression, [FFrameRate](API\Runtime\Core\Misc\FFrameRate) InFrameRate, bool & OutDirectlyParsed ) const


description: Evaluate the given expression, resulting in either a double value, or an error

code: [TValueOrError](API\Runtime\Core\Math\TValueOrError)< [FFrameTime](API\Runtime\Core\Misc\FFrameTime), [FExpressionError](API\Runtime\Core\Misc\FExpressionError) > EvaluateTimecode ( const TCHAR * InExpression, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InDisplayFrameRate, const [FFrameRate](API\Runtime\Core\Misc\FFrameRate) & InTickResolution, bool & OutDirectlyParsed ) const


description: Constructor that sets up the parser's lexer and compiler

code: FFrameNumberTimeEvaluator()


className: FFrameNumberTimeEvaluator

code: struct FFrameNumberTimeEvaluator

FrameGrammar

type: FExpressionGram...

FrameTokenDefinitions

type: FTokenDefinitio...

TimeJumpTable

type: FOperatorJumpTa...


code: static const TCHAR *const Moniker = TEXT("f");


code: static const TCHAR *const Moniker = TEXT("h");


description: Convert the type to/from a string

code: virtual [FString](API\Runtime\Core\Containers\FString) ToString ( const double & Value ) const


code: static const TCHAR *const Moniker = TEXT("ms");


className: FMillisecond

code: struct FMillisecond


code: static const TCHAR *const Moniker = TEXT("m");


code: static const TCHAR *const Moniker = TEXT("s");


className: FTimecodeDelimiter

code: struct FTimecodeDelimiter


code: static const TCHAR *const Moniker = TEXT(":");


code: double AsSeconds ( ETimedDataInputEvaluationType EvaluationType ) const


code: FTimedDataChannelSampleTime()


code: FTimedDataChannelSampleTime ( double InPlatformSeconds, const [FQualifiedFrameTime](API\Runtime\Core\Misc\FQualifiedFrameTime) & InTimecode )


className: FTimedDataChannelSampleTime

code: struct FTimedDataChannelSampleTime

PlatformSecond

type: double

description: The time is relative toFPlatformTime::Seconds.

Timecode

type: FQualifiedFrame...

description: Timecode value of the sample


description: Add an input channel to the collection.

code: void Add ( [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * Channel )


description: Add an timed input to the collection.

code: void Add ( [ITimedDataInput](API\Runtime\TimeManagement\ITimedDataInput) * Input )


description: The list of input channels from the collection.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * > & GetChannels() const


description: The list of inputs from the collection.

code: const [TArray](API\Runtime\Core\Containers\TArray)< [ITimedDataInput](API\Runtime\TimeManagement\ITimedDataInput) * > & GetInputs() const


description: When an element is added or removed to the collection.


description: Remove an input from the collection.

code: void Remove ( [ITimedDataInput](API\Runtime\TimeManagement\ITimedDataInput) * Input )


className: FTimedDataInputCollection

description: A list of all the timed data input.

code: class FTimedDataInputCollection


className: FTimedDataInputEvaluationData

code: struct FTimedDataInputEvaluationData

DistanceToNewestSampleSeconds

type: float

description: Distance between evaluation time and newest sample in seconds


className: FTimeSynchronizationOpenData

code: struct FTimeSynchronizationOpenData

RolloverFrame

type: TOptional<FFra...

description: The frame on which rollover occurs (i.e., the modulus value of rollover).

SynchronizationFrameRate

description: Frame rate that will be used as the base for synchronization.


className: FTimeSynchronizationStartData

description: Values that will be sent to sources when synchronization has been successfully started.

code: struct FTimeSynchronizationStartData

StartFrame

type: FFrameTime

description: The frame on which synchronization was established.


description: Add a channel belonging to this input

code: void AddChannel ( [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * Channel )


description: Convert frame offset to second offset using this input's framerate.

code: double ConvertFrameOffsetInSecondOffset ( double Frames ) const


description: Remove an input channel from the collection.

code: void Remove ( [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * Input )


code: static double ConvertFrameOffsetInSecondOffset ( double Frames, [FFrameRate](API\Runtime\Core\Misc\FFrameRate) Rate )


description: Convert second offset to frame offset using this input's framerate.

code: double ConvertSecondOffsetInFrameOffset ( double Seconds ) const


code: static double ConvertSecondOffsetInFrameOffset ( double Seconds, [FFrameRate](API\Runtime\Core\Misc\FFrameRate) Rate )


description: Get a list of the channel this input has.

code: [TArray](API\Runtime\Core\Containers\TArray)< [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * > GetChannels() const


description: If the input does supported it, get the size of the buffer used by the input.

code: virtual int32 GetDataBufferSize() const


description: Get the icon that represent the input.

code: const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * GetDisplayIcon() const


description: Get the offset in seconds used at evaluation.


description: Get the name used when displayed.


description: Get how the input is evaluated.


description: Get the frame rate at which the samples are produced.


description: Does channel from this input support a different buffer size than it's input.


description: Remove channel from the input

code: void RemoveChannel ( [ITimedDataInputChannel](API\Runtime\TimeManagement\ITimedDataInputChannel) * Channel )


description: If the input does supported it, set the size of the buffer used by the input.

code: virtual void SetDataBufferSize ( int32 BufferSize )


description: Set the offset in seconds used at evaluation.

code: void SetEvaluationOffsetInSeconds ( double Offset )


description: Set how the input is evaluated.

code: void SetEvaluationType ( ETimedDataInputEvaluationType Evaluation )


description: Whether this input supports sub frames.

code: virtual bool SupportsSubFrames() const


className: UnknownFrameRate

code: static [FFrameRate](API\Runtime\Core\Misc\FFrameRate) UnknownFrameRate = FFrameRate(-1, -1);


code: virtual ~ITimedDataInput()


className: ITimedDataInput

description: Interface for data sources that can be synchronized with time

code: class ITimedDataInput


description: Return buffer overflow count detected by this input

code: int32 GetBufferOverflowStat() const


description: Return buffer underflow count detected by this input

code: int32 GetBufferUnderflowStat() const


description: If the channel does support it, get the current maximum sample count of channel.


description: Get the time of all the data samples available.

code: [TArray](API\Runtime\Core\Containers\TArray)< [FTimedDataChannelSampleTime](API\Runtime\TimeManagement\FTimedDataChannelSampleTime) > GetDataTimes() const


description: Return frame dropped count detected by this input

code: int32 GetFrameDroppedStat() const


description: Get the channel's display name.


description: Get data about last evaluation. Samples used, expected, number of samples.

code: void GetLastEvaluationData ( [FTimedDataInputEvaluationData](API\Runtime\TimeManagement\FTimedDataInputEvaluationData) & OutEvaluationData ) const


description: Get the time of the newest data sample available.


description: Get the number of data samples available.

code: int32 GetNumberOfSamples() const


description: Get the time of the oldest data sample available.


description: Get the current state of the channel.

code: ETimedDataInputState GetState() const


description: Is tracking of stats enabled for this input

code: bool IsBufferStatsEnabled() const


description: Resets internal stat counters

code: void ResetBufferStats()


description: Enables or disables stats tracking for this input

code: void SetBufferStatsEnabled ( bool bEnable )


description: If the channel does support it, set the maximum sample count of the channel.

code: virtual void SetDataBufferSize ( int32 BufferSize )


className: ITimedDataInputChannel

description: Interface for data tracked produced by an input.

code: class ITimedDataInputChannel