Module ptex_sys::ffi

cxx FFI bindings to the Ptex C++ API. The ffi module provides raw access to the underlying C++ APIs.

Structs

• BorderMode
  How to handle mesh border when filtering.
• DataType
  Type of data stored in texture file.
• EdgeFilterMode
  How to handle transformation across edges when filtering.
• EdgeId
  Edge IDs used in adjacency data in the Ptex::FaceInfo struct. Edge ID usage for triangle meshes is TBD.
• FaceInfo
  Information about a face, as stored in the Ptex file header.
• MeshType
  Type of base mesh for which the textures are defined. A mesh can be triangle-based (with triangular textures) or quad-based (with rectangular textures). */
• MetaDataType
  Type of meta data entry.
• PtexCache
  File-handle and memory cache for reading ptex files.
• PtexTexture
  Interface for reading data from a ptex file
• PtexWriter
  Interface for writing data to a ptex file.
• Res
  Pixel resolution of a given texture. The resolution is stored in log form: ulog2 = log2(ures), vlog2 = log2(vres)). Note: negative ulog2 or vlog2 values are reserved for internal use.

Functions

• data_size
  Return the size in bytes of the specified DataType.
• faceinfo_adjacent_edge
  Return the adjacent edge for this face.
• faceinfo_adjacent_face
  Get the adjacent face for the specified face ID.
• faceinfo_default
  Create a default-constructed FaceInfo.
• faceinfo_from_res
  Create a FaceInfo from a Res.
• faceinfo_from_res_and_adjacency
  Create a FaceInfo from a Res and adjacency information.
• faceinfo_has_edits
  Return true if the FaceInfo contains edits.
• faceinfo_is_constant
  Return true if the FaceInfo contains constant data.
• faceinfo_is_neighborhood_constant
  Return true if the FaceInfo is in a neighborhood of constant faces.
• faceinfo_is_subface
  Return true if the FaceInfo is a subface.
• faceinfo_set_adjacent_edges
  Set the adjacent edges.
• faceinfo_set_adjacent_faces
  Set the adjacent faces.
• one_value
  Return the value of “1.0” for the specified DataType (1.0 (float), 255.0 (8bit), …).
• one_value_inverse
  Return the 1.0/value of “1.0” for the specified DataType (1/1.0 (float), 1/255.0 (8bit), …).
• ptexcache_create^⚠
  Create a cache with the specified limits.
• ptexcache_get^⚠
  Access a texture. If the specified path was previously accessed from the cache, then a pointer to the cached texture will be returned.
• ptexcache_get_search_path^⚠
  Query the search path. Returns string set via ptexcache_set_search_path.
• ptexcache_release^⚠
  Release a PtexCache Cache will be immediately destroyed and all resources will be released.
• ptexcache_set_search_path^⚠
  Set a search path for finding textures. Parameters:
• ptextexture_get_alpha_channel^⚠
  Get the alpha channel for the specified PtexTexture.
• ptextexture_get_border_mode_u^⚠
  Get the BorderMode for the specified PtexCache and direction.
• ptextexture_get_border_mode_v^⚠
  Get the BorderMode for the specified PtexCache and direction.
• ptextexture_get_datatype^⚠
  Get the DataType for the specified PtexCache.
• ptextexture_get_edge_filter_mode^⚠
  Get the EdgeFilterMode for the specified PtexCache.
• ptextexture_get_face_info^⚠
  Get the FaceInfo for the specified PtexTexture and faceid.
• ptextexture_get_meshtype^⚠
  Get the MeshType for the specified PtexCache.
• ptextexture_get_num_channels^⚠
  Get the number of channels for the specified PtexTexture.
• ptextexture_get_num_faces^⚠
  Get the number of faces for the specified PtexTexture.
• ptextexture_get_path^⚠
  Get the path for the specified PtexCache.
• ptextexture_get_pixel^⚠
  Get the pixel value for the specified PtexCache.
• ptextexture_has_edits^⚠
  Return true if the PtexTexture contains edits.
• ptextexture_has_mipmaps^⚠
  Return true if the PtexTexture has mip maps.
• ptextexture_release^⚠
  Release a PtexTexture instance.
• ptexwriter_close^⚠
  Close an open PtexWriter.
• ptexwriter_open^⚠
  Create a PtexWriter.
• ptexwriter_release^⚠
  Release a PtexWriter.
• ptexwriter_write_face^⚠
  Writer a face to a PtexWriter
• res_clamp
  Clamp the resolution value against the given value.
• res_default
  Create a default-constructed Res.
• res_from_uv
  Create a Res from u and v log2 sizes.
• res_from_value
  Create a Res from a packed u16 value.
• res_ntiles
  Determine the total number of tiles for the given tile res.
• res_ntilesu
  Determine the number of tiles in the u direction for the given tile res.
• res_ntilesv
  Determine the number of tiles in the v direction for the given tile res.
• res_size
  Return the size for a Res object.
• res_swappeduv
  Return a Res object with swapped u, v values
• res_swapuv
  Swap the u, v values in-place on a Res.
• res_u
  Return the log2 resolution in the u direction.
• res_v
  Return the log2 resolution in the v direction.