1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
/// cxx FFI bindings to the Ptex C++ API.
/// The ffi module provides raw access to the underlying C++ APIs.
#[cxx::bridge(namespace = "Ptex")]
pub mod ffi {
/// How to handle mesh border when filtering.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u32)]
enum BorderMode {
/// texel access is clamped to border
#[cxx_name = "m_clamp"]
Clamp,
/// texel beyond border are assumed to be black
#[cxx_name = "m_black"]
Black,
/// texel access wraps to other side of face
#[cxx_name = "m_periodic"]
Periodic,
}
/// Type of data stored in texture file.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u32)]
enum DataType {
/// Unsigned, 8-bit integer.
#[cxx_name = "dt_uint8"]
UInt8,
/// Unsigned, 16-bit integer.
#[cxx_name = "dt_uint16"]
UInt16,
/// Half-precision (16-bit) floating point.
#[cxx_name = "dt_half"]
Float16,
/// Single-precision (32-bit) floating point.
#[cxx_name = "dt_float"]
Float32,
}
/// How to handle transformation across edges when filtering.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u32)]
enum EdgeFilterMode {
/// Don't do anything with the values.
#[cxx_name = "efm_none"]
None,
/// Values are vectors in tangent space; rotate values.
#[cxx_name = "efm_tanvec"]
TangentVector,
}
/// Edge IDs used in adjacency data in the Ptex::FaceInfo struct.
/// Edge ID usage for triangle meshes is TBD.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u32)]
enum EdgeId {
/// Bottom edge, from UV (0,0) to (1,0)
#[cxx_name = "e_bottom"]
Bottom,
/// Right edge, from UV (1,0) to (1,1)
#[cxx_name = "e_right"]
Right,
/// Top edge, from UV (1,1) to (0,1)
#[cxx_name = "e_top"]
Top,
/// Left edge, from UV (0,1) to (0,0)
#[cxx_name = "e_left"]
Left,
}
/// Type of meta data entry.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u32)]
enum MetaDataType {
/// Null-terminated string.
#[cxx_name = "mdt_string"]
String,
// Signed 8-bit integer.
#[cxx_name = "mdt_int8"]
Int8,
/// Signed 16-bit integer.
#[cxx_name = "mdt_int16"]
Int16,
/// Signed 32-bit integer.
#[cxx_name = "mdt_int32"]
Int32,
/// Single-precision (32-bit) floating point.
#[cxx_name = "mdt_float"]
Float,
/// Double-precision (32-bit) floating point.
#[cxx_name = "mdt_double"]
Double,
}
/// 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). */
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[repr(u32)]
enum MeshType {
/// Mesh is triangle-based.
#[cxx_name = "mt_triangle"]
Triangle,
/// Mesh is quad-based.
#[cxx_name = "mt_quad"]
Quad,
}
/// 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.
#[derive(Copy, Clone, Debug)]
struct Res {
/// log2 of u resolution, in texels
ulog2: i8,
/// log2 of v resolution, in texels
vlog2: i8,
}
/// Information about a face, as stored in the Ptex file header.
#[derive(Clone, Copy, Debug)]
struct FaceInfo {
/// Resolution of face.
res: Res,
///< Adjacent edges, 2 bits per edge.
adjedges: u8,
/// Flags.
flags: u8,
/// Adjacent faces (-1 == no adjacent face).
adjfaces: [u32; 4],
}
unsafe extern "C++" {
include!("Ptexture.h");
include!("ptex-sys.h");
/// How to handle mesh border when filtering.
type BorderMode;
/// Type of data stored in texture file.
type DataType;
/// How to handle transformation across edges when filtering.
type EdgeFilterMode;
/// 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). */
type MeshType;
/// Type of meta data entry.
type MetaDataType;
/// File-handle and memory cache for reading ptex files.
type PtexCache;
/// Interface for reading data from a ptex file
type PtexTexture;
/// Interface for writing data to a ptex file.
type PtexWriter;
// struct Res
/// Create a default-constructed Res.
#[namespace = "Ptex::sys"]
fn res_default() -> Res;
/// Create a Res from u and v log2 sizes.
#[namespace = "Ptex::sys"]
fn res_from_uv(u: i8, v: i8) -> Res;
/// Create a Res from a packed u16 value.
#[namespace = "Ptex::sys"]
fn res_from_value(value: u16) -> Res;
/// Return the log2 resolution in the u direction.
#[namespace = "Ptex::sys"]
fn res_u(res: &Res) -> i32;
/// Return the log2 resolution in the v direction.
#[namespace = "Ptex::sys"]
fn res_v(res: &Res) -> i32;
/// Return the size for a Res object.
#[namespace = "Ptex::sys"]
fn res_size(res: &Res) -> i32;
fn val(self: &Res) -> u16;
/// Return a Res object with swapped u, v values
#[namespace = "Ptex::sys"]
fn res_swappeduv(res: &Res) -> Res;
/// Swap the u, v values in-place on a Res.
#[namespace = "Ptex::sys"]
fn res_swapuv(res: &mut Res);
/// Clamp the resolution value against the given value.
#[namespace = "Ptex::sys"]
fn res_clamp(res: &mut Res, clamp_res: &Res);
/// Determine the number of tiles in the u direction for the given tile res.
#[namespace = "Ptex::sys"]
fn res_ntilesu(res: &Res, tileres: Res) -> i32;
/// Determine the number of tiles in the v direction for the given tile res.
#[namespace = "Ptex::sys"]
fn res_ntilesv(res: &Res, tileres: Res) -> i32;
/// Determine the total number of tiles for the given tile res.
#[namespace = "Ptex::sys"]
fn res_ntiles(res: &Res, tileres: Res) -> i32;
// struct FaceInfo
/// Create a default-constructed FaceInfo.
#[namespace = "Ptex::sys"]
fn faceinfo_default() -> FaceInfo;
/// Create a FaceInfo from a Res.
#[namespace = "Ptex::sys"]
fn faceinfo_from_res(res: Res) -> FaceInfo;
/// Create a FaceInfo from a Res and adjacency information.
#[namespace = "Ptex::sys"]
fn faceinfo_from_res_and_adjacency(
res: Res,
adjacent_faces: &[i32; 4],
adjacent_edges: &[i32; 4],
is_subface: bool,
) -> FaceInfo;
/// Return true if the FaceInfo contains edits.
#[namespace = "Ptex::sys"]
fn faceinfo_has_edits(face_info: &FaceInfo) -> bool;
/// Return true if the FaceInfo contains constant data.
#[namespace = "Ptex::sys"]
fn faceinfo_is_constant(face_info: &FaceInfo) -> bool;
/// Return true if the FaceInfo is in a neighborhood of constant faces.
#[namespace = "Ptex::sys"]
fn faceinfo_is_neighborhood_constant(face_info: &FaceInfo) -> bool;
/// Return true if the FaceInfo is a subface.
#[namespace = "Ptex::sys"]
fn faceinfo_is_subface(face_info: &FaceInfo) -> bool;
/// Return the adjacent edge for this face.
#[namespace = "Ptex::sys"]
fn faceinfo_adjacent_edge(face_info: &FaceInfo, edge_id: i32) -> EdgeId;
/// Get the adjacent face for the specified face ID.
#[namespace = "Ptex::sys"]
fn faceinfo_adjacent_face(face_info: &FaceInfo, edge_id: i32) -> i32;
/// Set the adjacent faces.
#[namespace = "Ptex::sys"]
fn faceinfo_set_adjacent_faces(
face_info: &mut FaceInfo,
f1: i32,
f2: i32,
f3: i32,
f4: i32,
);
/// Set the adjacent edges.
#[namespace = "Ptex::sys"]
fn faceinfo_set_adjacent_edges(
face_info: &mut FaceInfo,
e1: EdgeId,
e2: EdgeId,
e3: EdgeId,
e4: EdgeId,
);
/// Return the value of "1.0" for the specified DataType (1.0 (float), 255.0 (8bit), ...).
#[cxx_name = "OneValue"]
fn one_value(data_type: DataType) -> f32;
/// Return the 1.0/value of "1.0" for the specified DataType (1/1.0 (float), 1/255.0 (8bit), ...).
#[cxx_name = "OneValueInv"]
fn one_value_inverse(data_type: DataType) -> f32;
/// Return the size in bytes of the specified DataType.
#[cxx_name = "DataSize"]
fn data_size(data_type: DataType) -> i32;
/// Create a cache with the specified limits.
/// # Safety
/// The value returned must be released using ptexcache_release.
#[namespace = "Ptex::sys"]
unsafe fn ptexcache_create(
max_files: i32,
max_mem: usize,
premultiply: bool,
) -> *mut PtexCache;
// class PtexCache
/// Release a PtexCache
/// Cache will be immediately destroyed and all resources will be released.
/// # Safety
/// This function must be called with a valid PtexCache pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptexcache_release(cache: *mut PtexCache);
/// Set a search path for finding textures.
/// Parameters:
/// - path: colon-delimited search path.
/// # Safety
/// This function must be called with a valid PtexCache pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptexcache_set_search_path(cache: *mut PtexCache, path: &str);
/// Query the search path. Returns string set via `ptexcache_set_search_path`.
/// # Safety
/// This function must be called with a valid PtexCache pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptexcache_get_search_path(cache: *const PtexCache) -> String;
// class PtexTexture
/// Release a PtexTexture instance.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_release(cache: *mut PtexTexture);
/// Return true if the PtexTexture contains edits.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_has_edits(cache: *const PtexTexture) -> bool;
/// Return true if the PtexTexture has mip maps.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_has_mipmaps(cache: *const PtexTexture) -> bool;
/// Get the alpha channel for the specified PtexTexture.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_alpha_channel(cache: *const PtexTexture) -> i32;
/// Get the number of channels for the specified PtexTexture.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_num_channels(cache: *const PtexTexture) -> i32;
/// Get the number of faces for the specified PtexTexture.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_num_faces(cache: *const PtexTexture) -> i32;
/// Get the path for the specified PtexCache.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_path(cache: *const PtexTexture) -> String;
/// Get the MeshType for the specified PtexCache.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_meshtype(cache: *const PtexTexture) -> MeshType;
/// Get the DataType for the specified PtexCache.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_datatype(cache: *const PtexTexture) -> DataType;
/// Get the BorderMode for the specified PtexCache and direction.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_border_mode_u(cache: *const PtexTexture) -> BorderMode;
/// Get the BorderMode for the specified PtexCache and direction.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_border_mode_v(cache: *const PtexTexture) -> BorderMode;
/// Get the EdgeFilterMode for the specified PtexCache.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_edge_filter_mode(cache: *const PtexTexture) -> EdgeFilterMode;
/// Get the FaceInfo for the specified PtexTexture and faceid.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_face_info<'a>(
cache: *const PtexTexture,
faceid: i32,
) -> &'a FaceInfo;
/// Get the pixel value for the specified PtexCache.
/// # Safety
/// This function must be called with a valid PtexTexture pointer.
#[namespace = "Ptex::sys"]
unsafe fn ptextexture_get_pixel(
cache: *const PtexTexture,
faceid: i32,
u: i32,
v: i32,
first_channel: i32,
num_channels: i32,
) -> f32;
/// Access a texture. If the specified path was previously accessed
/// from the cache, then a pointer to the cached texture will be
/// returned.
///
/// If the specified path hasn't been opened yet or was purged
/// from the cache (via the purge or purgeAll methods) then the
/// file will be opened. If the path is relative (i.e. doesn't
/// begin with a '/') then the search path will be used to locate
/// the file.
///
/// The texture will be accessible until the PtexTexture::release
/// method is called, at which point the texture will be returned
/// to the cache. Once released, the texture may have it's data
/// pruned (immediately or some time later) to stay within the
/// maximum cache size.
///
/// If the texture could not be opened, null will be returned and
/// an error string will be set. If an error were previously
/// encountered with the file (include the file not being found),
/// null will be returned and no error string will be set.
///
/// Parameters:
/// - filename: File path. If path is relative, search path will
/// be used to find the file.
/// - error_str: Error string to set if texture could not be opened.
///
/// # Safety
/// The Texture must not outlive its owning Cache.
#[namespace = "Ptex::sys"]
unsafe fn ptexcache_get(
cache: *mut PtexCache,
filename: &str,
error_str: *mut CxxString,
) -> *mut PtexTexture;
/// Create a PtexWriter.
///
/// # Safety
/// Should not be called outside of the ptex::ffi::sys crate.
#[allow(clippy::too_many_arguments)]
#[namespace = "Ptex::sys"]
unsafe fn ptexwriter_open(
filename: &str,
meshtype: MeshType,
datatype: DataType,
num_channels: i32,
alpha_channel: i32,
num_faces: i32,
genmipmaps: bool,
error_str: *mut CxxString,
) -> *mut PtexWriter;
/// Release a PtexWriter.
///
/// # Safety
/// Must only be called on pointers returned from ptexwriter_open().
#[namespace = "Ptex::sys"]
unsafe fn ptexwriter_release(writer: *mut PtexWriter);
/// Close an open PtexWriter.
///
/// # Safety
/// Must only be called on valid PtexWriter pointers.
#[namespace = "Ptex::sys"]
unsafe fn ptexwriter_close(writer: *mut PtexWriter) -> String;
/// Writer a face to a PtexWriter
///
/// # Safety
/// Must only be called on valid PtexWriter pointers.
#[namespace = "Ptex::sys"]
unsafe fn ptexwriter_write_face(
writer: *mut PtexWriter,
face_id: i32,
face_info: &FaceInfo,
data: *const u8,
stride: i32,
) -> bool;
}
}
impl Default for Res {
/// Default constructor, sets res to 0 (1x1 texel).
fn default() -> Self {
ffi::res_default()
}
}
impl Eq for Res {}
impl PartialEq for Res {
fn eq(&self, res: &ffi::Res) -> bool {
self.ulog2 == res.ulog2 && self.vlog2 == res.vlog2
}
}
impl Res {
/// Return the log2 resolution in the u direction.
pub fn u(&self) -> i32 {
ffi::res_u(self)
}
/// Return the log2 resolution in the v direction.
pub fn v(&self) -> i32 {
ffi::res_v(self)
}
/// Return the size of the FaceInfo.
pub fn size(&self) -> i32 {
ffi::res_size(self)
}
/// Return a Res instance with swapped u, v values.
pub fn swapped_uv(&self) -> i32 {
ffi::res_size(self)
}
}
impl Default for FaceInfo {
fn default() -> Self {
ffi::faceinfo_default()
}
}
impl FaceInfo {
pub fn from_res_and_adjacency<T: Into<Res>>(
res: T,
adjacent_faces: &[i32; 4],
adjacent_edges: &[i32; 4],
is_subface: bool,
) -> Self {
ffi::faceinfo_from_res_and_adjacency(res.into(), adjacent_faces, adjacent_edges, is_subface)
}
/// Return a Res resolution struct.
pub fn resolution(&self) -> Res {
self.res
}
/// Set the resolution for this face.
pub fn set_resolution<T: Into<Res>>(&mut self, res: T) {
self.res = res.into();
}
/// Return the adjacent edge for this face.
pub fn adjacent_edge(&self, edge_id: i32) -> EdgeId {
ffi::faceinfo_adjacent_edge(self, edge_id)
}
/// Set the adjacent edges.
pub fn set_adjacent_edges(&mut self, e1: EdgeId, e2: EdgeId, e3: EdgeId, e4: EdgeId) {
ffi::faceinfo_set_adjacent_edges(self, e1, e2, e3, e4);
}
/// Get the adjacent face for the specified face ID.
pub fn adjacent_face(&self, face_id: i32) -> i32 {
ffi::faceinfo_adjacent_face(self, face_id)
}
/// Set the adjacent faces.
pub fn set_adjacent_faces(&mut self, f1: i32, f2: i32, f3: i32, f4: i32) {
ffi::faceinfo_set_adjacent_faces(self, f1, f2, f3, f4);
}
/// Return true if the FaceInfo contains edits.
pub fn has_edits(&self) -> bool {
ffi::faceinfo_has_edits(self)
}
/// Return true if the FaceInfo contains constant data.
pub fn is_constant(&self) -> bool {
ffi::faceinfo_is_constant(self)
}
/// Return true if the FaceInfo is in a neighborhood of constant faces.
pub fn is_neighborhood_constant(&self) -> bool {
ffi::faceinfo_is_neighborhood_constant(self)
}
/// Return true if the FaceInfo represents a subface.
pub fn is_subface(&self) -> bool {
ffi::faceinfo_is_subface(self)
}
}
pub use ffi::*;