devela::_dep::sdl3::sys::stdinc

Function SDL_crc16

pub unsafe extern "C" fn SDL_crc16(
    crc: u16,
    data: *const c_void,
    len: usize,
) -> u16
Available on crate feature dep_sdl3 only.
Expand description

Calculate a CRC-16 value.

https://en.wikipedia.org/wiki/Cyclic_redundancy_check

This function can be called multiple times, to stream data to be checksummed in blocks. Each call must provide the previous CRC-16 return value to be updated with the next block. The first call to this function for a set of blocks should pass in a zero CRC value.

§Parameters

  • crc: the current checksum for this data set, or 0 for a new data set.
  • data: a new block of data to add to the checksum.
  • len: the size, in bytes, of the new block of data.

§Return value

Returns a CRC-16 checksum value of all blocks in the data set.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.