Crate xc3_model

xc3_model

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

Each type represents fully compressed and decoded data associated with one or more xc3_lib types. This simplifies the processing that needs to be done to access model data and abstracts away most of the game specific complexities.

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!("{}", roots[0].image_textures.len());

Modules

• animation
  Utilities for working with animation data.
• monolib
  Utilities for loading textures from the monolib/shader folder.
• 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.
• ImageTexture
  A non swizzled version of an Mibl or Mtxt texture.
• LodData
  See LodData.
• LodGroup
  See LodGroup.
• LodItem
  See LodItem.
• MapRoot
• Material
  See Material and FoliageMaterial.
• MaterialFlags
• MaterialParameters
  Values assigned to known shader uniforms or None if not present.
• MaterialRenderFlags
• Mesh
  See Mesh.
• MeshRenderFlags2
  Flags to determine how to draw a Mesh.
• Model
  See Model.
• ModelGroup
• ModelRoot
• Models
  See Models.
• OutputAssignment
• OutputAssignments
  Assignment information for the channels of each output. This includes channels from textures, material parameters, or shader constants.
• OutputLayerAssignment
• Sampler
  See SamplerFlags.
• Skeleton
  See Skeleton and Skinning.
• StateFlags
  Flags controlling pipeline state for rasterizer and fragment state.
• StreamingData
• Texture
  Selects an ImageTexture and Sampler.
• TextureAlphaTest
  Information for alpha testing based on sampled texture values.
• TextureAssignment

Enums

• AddressMode
  How edges should be handled in texture addressing.
• BlendMode
• ChannelAssignment
• ColorWriteMode
• CullMode
• DepthFunc
• ExtractedTextures
• FilterMode
  Texel mixing mode when sampling between texels.
• ImageFormat
  nvn image format types used by Xenoblade 1 DE, Xenoblade 2, and Xenoblade 3.
• LoadMapError
• LoadModelError
• MeshRenderPass
  The render pass for this draw call.
• RenderPassType
• StencilMode
• StencilValue
• TextureUsage
  Hints on how the texture is used. Actual usage is determined by the shader.
• ViewDimension

Traits

• IndexMapExt
  A trait for mapping unique items to an index.

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.
• load_model_legacy
  Load a model from a .camdo file. The corresponding .casmtshould be in the same directory.