IPhysXCooking

[IPhysXCooking](API\Runtime\Engine\Physics\IPhysXCooking), PhysX cooking and serialization abstraction

Windows
MacOS
Linux

Inheritance Hierarchy

IPhysXCooking

FPhysXCooking

Syntax

class IPhysXCooking

Remarks

IPhysXCooking, PhysX cooking and serialization abstraction

Destructors

Name Description

Public function Virtual

~IPhysXCooking()

Virtual destructor.

Functions

Name Description

Public function Virtual Const

bool

 

AllowParallelBuild()

Checks whether parallel PhysX cooking is allowed.

Note: This method is not currently used yet.

Public function Const

EPhysXCookin...

 

CookConvex

(
    FName Format,
    EPhysXMeshCookFlags CookFlags,
    const TArray< FVector >& SrcBuffer,
    TArray< uint8 >& OutBuffer
)

Cooks the source convex data for the platform and stores the cooked data internally.

Public function Const

bool

 

CookHeightField

(
    FName Format,
    FIntPoint HFSize,
    const void* Samples,
    uint32 SamplesStride,
    TArray< uint8 >& OutBuffer
)

Cooks the source height field data for the platform and stores the cooked data internally.

Public function Const

bool

 

CookTriMesh

(
    FName Format,
    EPhysXMeshCookFlags CookFlags,
    const TArray< FVector >& SrcVertic...,
    const TArray< struct FTriIndices > ...,
    const TArray< uint16 >& SrcMateria...,
    const bool FlipNormals,
    TArray< uint8 >& OutBuffer
)

Cooks the source Tri-Mesh data for the platform and stores the cooked data internally.

Public function Const

EPhysXCookin...

 

CreateConvex

(
    FName Format,
    EPhysXMeshCookFlags CookFlags,
    const TArray< FVector >& SrcBuffer,
    physx::PxConvexMesh*& OutBuffe...
)

Cooks the source convex data for the platform and returns the PhysX geometry directly (meant for runtime when you just need the geometry directly without serializing out)

Public function Const

bool

 

CreateHeightField

(
    FName Format,
    FIntPoint HFSize,
    const void* Samples,
    uint32 SamplesStride,
    physx::PxHeightField*& OutHeig...
)

Cooks the source height field data for the platform and returns the PhysX geometry directly (meant for runtime when you just need the geometry directly without serializing out)

Public function Const

bool

 

CreateTriMesh

(
    FName Format,
    EPhysXMeshCookFlags CookFlags,
    const TArray< FVector >& SrcVertic...,
    const TArray< struct FTriIndices > ...,
    const TArray< uint16 >& SrcMateria...,
    const bool FlipNormals,
    physx::PxTriangleMesh*& OutTri...
)

Cooks the source Tri-Mesh data for the platform and returns the PhysX geometry directly (meant for runtime when you just need the geometry directly without serializing out)

Public function Const

physx::PxCoo...

 

GetCooking()

Get the actual physx cooker object

Public function Const

void

 

GetSupportedFormats

(
    TArray< FName >& OutFormats
)

Gets the list of supported formats.

Public function Const

uint16

 

GetVersion

(
    FName Format
)

Gets the current version of the specified PhysX format.

References

Module

Engine

Header

Runtime/Engine/Public/Physics/IPhysXCooking.h

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback