UsdPmcMeshEncoder Class Reference

Encode UsdGeomMesh data into PMC compressed format. More...

#include <usdPmcEncoder.h>

Public Member Functions
USDPMC_API bool	CanEncode (const UsdGeomMesh &mesh)
	Check if the given mesh can be encoded to PMC format.
USDPMC_API std::vector< uint8_t >	Encode (UsdGeomMesh *mesh, const VtDictionary &options, std::set< std::string > *processedAttributes, std::set< std::string > *processedSubSets, VtDictionary *resultInfo)
	Encode a UsdGeomMesh into PMC compressed format.
USDPMC_API bool	EncodeStage (std::filesystem::path inFile, std::filesystem::path outFile, const VtDictionary &options)
	Encode all UsdGeomMesh in a USD stage into PMC compressed format.

Detailed Description

Encode UsdGeomMesh data into PMC compressed format.

This class provides functionality to encode USD geometry into PMC compressed mesh data. It handles the conversion of USD geometry, attributes, and metadata into the PMC format for efficient storage and transmission.

Definition at line 34 of file usdPmcEncoder.h.

Member Function Documentation

CanEncode()

USDPMC_API bool CanEncode

(

const UsdGeomMesh &

mesh

)

Check if the given mesh can be encoded to PMC format.

Parameters

mesh	The UsdGeomMesh to check for encoding compatibility

Returns

true if the mesh can be encoded, false otherwise

Encode()

USDPMC_API std::vector< uint8_t > Encode	(	UsdGeomMesh *	mesh,
		const VtDictionary &	options,
		std::set< std::string > *	processedAttributes,
		std::set< std::string > *	processedSubSets,
		VtDictionary *	resultInfo )

Encode a UsdGeomMesh into PMC compressed format.

Parameters

mesh	Pointer to the UsdGeomMesh to encode
options	Encoding options and parameters
processedAttributes	Pointer to set to store names of processed attributes
processedSubSets	Pointer to set to store names of processed subsets
resultInfo	Pointer to dictionary to store encoding result information

Returns

Encoded PMC data as a byte vector

EncodeStage()

USDPMC_API bool EncodeStage	(	std::filesystem::path	inFile,
		std::filesystem::path	outFile,
		const VtDictionary &	options )

Encode all UsdGeomMesh in a USD stage into PMC compressed format.

Parameters

inFile	Path to input file
outFile	Path to output file with PMC compression

Returns

true if encoding was successful, false otherwise

---

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

• pxr/usd/usdPmc/usdPmcEncoder.h