Crate xc3_model

xc3_model

xc3_model provides high level data access for the files that make up a model.

Each type typically represents the decoded data associated with one or more types in xc3_lib. This simplifies the processing that needs to be done to access model data and abstracts away most of the game specific complexities. This conversion is currently one way, so saving types back to files is not yet supported.

Getting Started

Loading a normal model returns a single ModelRoot. Loading a map returns multiple ModelRoot. Each ModelRoot has its own set of images.

The ShaderDatabase is optional and improves the accuracy of texture and material assignments.

use xc3_model::shader_database::ShaderDatabase;

let database = ShaderDatabase::from_file("xc3.json");

let root = xc3_model::load_model("ch01011013.wimdo", Some(&database));
println!("{}", root.image_textures.len());

let roots = xc3_model::load_map("ma59a.wismhd", Some(&database));
println!("{}", root.image_textures.len());

Modules

• animation
  Utilities for working with animation data.
• gltf
  Conversions from xc3_model types to glTF.
• shader_database
  Database for compiled shader metadata for more accurate rendering.
• skinning
  Utilities for working with vertex skinning.
• vertex
  Utilities for working with vertex buffer data.

Structs

• Bone
  A single node in the skeleton heirarchy.
• GBufferAssignment
• GBufferAssignments
  Assignment information for the channels of each output. This includes channels from textures, material parameters, or shader constants.
• ImageTexture
  A non swizzled version of an Mibl texture.
• IndexBuffer
  See IndexBufferDescriptor.
• Material
  See Material and FoliageMaterial.
• MaterialParameters
  Values assigned to known shader uniforms or None if not present.
• Mesh
  See Mesh.
• Model
  See Model.
• ModelBuffers
  See VertexData.
• ModelGroup
• ModelRoot
• Models
  See Models.
• MorphTarget
  Morph target attributes defined as a difference or deformation from the base target.
• Sampler
  See SamplerFlags.
• Skeleton
  See Skeleton and Skinning.
• StateFlags
  Flags controlling pipeline state for rasterizer and fragment state.
• Texture
  Selects an ImageTexture and Sampler.
• TextureAlphaTest
  Information for alpha testing based on sampled texture values.
• VertexBuffer
  See VertexBufferDescriptor.
• Weights
  See Weights.

Enums

• AddressMode
  How edges should be handled in texture addressing.
• BlendState
• ChannelAssignment
• FilterMode
  Texel mixing mode when sampling between texels.
• ImageFormat
  nvn image format types used by Xenoblade 1 DE, Xenoblade 2, and Xenoblade 3.
• ShaderUnkType
  Determines the render pass for an object.
• ViewDimension

Functions

• load_animations
  Load all animations from a .anm, .mot, or .motstm_data file.
• load_map
  Load a map from a .wismhd file. The corresponding .wismda should be in the same directory.
• load_model
  Load a model from a .wimdo or .pcmdo file. The corresponding .wismt or .pcsmt and .chr or .arc should be in the same directory.
• should_render_lod
  Returns true if a mesh with lod should be rendered as part of the highest detail or base level of detail (LOD).