Click or drag to resize

Syroot.NintenTools.Bfres Namespace

The root namespace of the library contains all classes and structures appearing in a BFRES file.
Classes
  ClassDescription
Public classAnimCurve
Represents an animation curve used by several sections to control different parameters over time.
Public classBone
Represents a single bone in a Skeleton section, storing its initial transform and transformation effects.
Public classBoneAnim
Represents the animation of a single Bone in a SkeletalAnim subfile.
Public classBoundingNode
Represents a node in a SubMesh bounding tree to determine when to show which sub mesh of a Mesh.
Public classBuffer
Represents a buffer of data uploaded to the GX2 GPU which can hold arbitrary data.
Public classCameraAnim
Represents an FCAM section in a SceneAnim subfile, storing animations controlling camera settings.
Public classExternalFile
Represents a file attachment to a ResFile which can be of arbitrary data.
Public classFogAnim
Represents an FCAM section in a SceneAnim subfile, storing animations controlling fog settings.
Public classKeyShape
Public classKeyShapeAnimInfo
Represents a key shape animation info in a VertexShapeAnim instance.
Public classLightAnim
Represents an FLIT section in a SceneAnim subfile, storing animations controlling light settings.
Public classMaterial
Represents an FMAT subsection of a Model subfile, storing information on with which textures and how technically a surface is drawn.
Public classMesh
Represents the surface net of a Shape section, storing information on which index Buffer to use for referencing vertices of the shape, mostly used for different levels of detail (LoD) models.
Public classModel
Represents an FMDL subfile in a ResFile, storing model vertex data, skeletons and used materials.
Public classParamAnimInfo
Represents a parameter animation info in a ShaderParamMatAnim instance.
Public classPatternAnimInfo
Represents a pattern animation info in a TexPatternMatAnim instance.
Public classRenderInfo
Represents a render info in a FMAT section storing uniform parameters required to render the UserData.
Public classRenderState
Public classResDict
Represents the non-generic base of a dictionary which can quickly look up IResData instances via key or index.
Protected classResDictNode
Represents a node forming the Patricia trie of the dictionary.
Public classResDictT
Represents a dictionary which can quickly look up IResData instances of type T via key or index.
Public classResException
Represents an exception raised when handling ResFile data.
Public classResFile
Represents a NintendoWare for Cafe (NW4F) graphics data archive file.
Public classResString
Represents a String which is stored in a ResFile.
Public classSampler
Represents a Texture sampler in a UserData section, storing configuration on how to draw and interpolate textures.
Public classSceneAnim
Represents an FSCN subfile in a ResFile, storing scene animations controlling camera, light and fog settings.
Public classShaderAssign
Public classShaderParam
Represents a parameter value in a UserData section, passing data to shader variables.
Public classShaderParamAnim
Represents an FSHU subfile in a ResFile, storing shader parameter animations of a Model instance.
Public classShaderParamMatAnim
Represents a material parameter animation in a ShaderParamAnim subfile.
Public classShape
Represents an FSHP section in a Model subfile.
Public classShapeAnim
Represents an FSHA subfile in a ResFile, storing shape animations of a Model instance.
Public classSkeletalAnim
Represents an FSKA subfile in a ResFile, storing armature animations of Bone instances in a Skeleton.
Public classSkeleton
Represents an FSKL section in a Model subfile, storing armature data.
Public classSubMesh
Represents a subarray of a Mesh section, storing a slice of indices to draw from the index buffer referenced in the mesh, mostly used for hiding parts of a model when not visible.
Public classTexPatternAnim
Represents an FTXP subfile in a ResFile, storing texture material pattern animations.
Public classTexPatternMatAnim
Represents a texture pattern material animation in a TexPatternAnim subfile.
Public classTexture
Represents an FMDL subfile in a ResFile, storing multi-dimensional texture data.
Public classTextureRef
Represents a reference to a Texture instance by name.
Public classUserData
Represents custom user variables which can be attached to many sections and subfiles of a ResFile.
Public classVertexAttrib
Represents an attribute of a VertexBuffer describing the data format, type and layout of a specific data subset in the buffer.
Public classVertexBuffer
Represents a data buffer holding vertices for a Model subfile.
Public classVertexShapeAnim
Represents a vertex shape animation in a ShapeAnim subfile.
Public classVisibilityAnim
Represents an FVIS subfile in a ResFile, storing visibility animations of Bone or Material instances.
Structures
  StructureDescription
Public structureAnimConstant
Public structureBoneAnimData
Represents the animatable data of a Bone instance.
Public structureBounding
Represents a spatial bounding box.
Public structureCameraAnimData
Represents the animatable data of scene cameras.
Public structureDecimal10x5
Represents a 16-bit fixed-point decimal consisting of 1 sign bit, 10 integer bits and 5 fractional bits (denoted as Q10.5). Note that the implementation is not reporting over- and underflowing errors.
Public structureDWord
Represents a 4-byte value which can hold differently typed data.
Public structureFogAnimData
Represents the animatable data of scene fog.
Public structureHalf
Represents a 16-bit half-precision floating point value according to the IEEE 754 standard.
Public structureLightAnimData
Represents the animatable data of scene lighting.
Public structureSrt2D
Represents a 2D transformation.
Public structureSrt3D
Represents a 3D transformation.
Public structureTexSrt
Represents a 2D texture transformation.
Public structureTexSrtEx
Represents a 2D texture transformation which is multiplied by a 3x4 matrix referenced at runtime by the MatrixPointer.
Enumerations
  EnumerationDescription
Public enumerationAnimCurveFrameType
Represents the possible data types in which Frames are stored. For simple library use, they are always converted them to and from Single instances.
Public enumerationAnimCurveKeyType
Represents the possible data types in which Keys are stored. For simple library use, they are always converted them to and from Single instances.
Public enumerationAnimCurveType
Represents the type of key values stored by this curve. This also determines the number of required elements to define a key in the Keys array. Use the ElementsPerKey method to retrieve the number of elements required for the CurveType of that curve.
Public enumerationBoneAnimDataOffset
Gets the AnimDataOffset for BoneAnimData instances.
Public enumerationBoneAnimFlagsBase
Represents if initial values exist for the corresponding transformation in the base animation data.
Public enumerationBoneAnimFlagsCurve
Represents if curves exist which animate the corresponding transformation component.
Public enumerationBoneAnimFlagsTransform
Represents how a bone transformation has to be applied.
Public enumerationBoneFlags
Represents flags controlling bone behavior.
Public enumerationBoneFlagsBillboard
Represents the possible transformations for bones to handle them as billboards.
Public enumerationBoneFlagsRotation
Represents the rotation method used to store bone rotations.
Public enumerationBoneFlagsTransform
Public enumerationBoneFlagsTransformCumulative
Public enumerationCameraAnimDataOffset
Gets the AnimDataOffset for CameraAnimData instances.
Public enumerationCameraAnimFlags
Represents flags specifying how animation data is stored or should be played.
Public enumerationFogAnimDataOffset
Gets the AnimDataOffset for FogAnimData instances.
Public enumerationFogAnimFlags
Represents flags specifying how animation data is stored or should be played.
Public enumerationLightAnimDataOffset
Gets the AnimDataOffset for LightAnimData instances.
Public enumerationLightAnimField
Represents flags specifying which fields are animated.
Public enumerationLightAnimFlags
Represents flags specifying how animation data is stored.
Public enumerationMaterialFlags
Represents general flags specifying how a Material is rendered.
Public enumerationRenderInfoType
Represents the data type of elements of the RenderInfo value array.
Public enumerationRenderStateFlagsBlendMode
Public enumerationRenderStateFlagsMode
Public enumerationShaderParamAnimFlags
Represents flags specifying how animation data is stored or should be played.
Public enumerationShaderParamType
Represents the data types in which ShaderParam instances can store their value.
Public enumerationShapeAnimFlags
Represents flags specifying how animation data is stored or should be played.
Public enumerationShapeFlags
Represents flags determining which data is available for Shape instances.
Public enumerationSkeletalAnimFlags
Represents flags specifying how animation data is stored or should be played.
Public enumerationSkeletalAnimFlagsRotate
Represents the data format in which rotation values are stored.
Public enumerationSkeletalAnimFlagsScale
Represents the data format in which scaling values are stored.
Public enumerationSkeletonFlagsRotation
Represents the rotation method used to store bone rotations.
Public enumerationSkeletonFlagsScaling
Public enumerationTexPatternAnimFlags
Represents flags specifying how animation data is stored or should be played.
Public enumerationTexSrtMode
Represents the texture transformation mode used in TexSrt and TexSrtEx.
Public enumerationUserDataType
Represents the possible data types of values stored in UserData instances.
Public enumerationVisibilityAnimFlags
Represents flags specifying how animation data is stored or should be played.
Public enumerationVisibilityAnimType
Represents the kind of data the visibility animation controls.