vpTranslate(3)

💅 vpTranslate(3) — the Library Functions Manual bestie edition ✨

okay so. this is vpTranslate from the VolPack library, and if you're here it's because you want your 3D stuff to move and honestly? iconic. let's get into it 🦋

🌸 NAME 🌸

vpTranslate — multiply the current transformation matrix by a translation matrix

like... you're sliding your whole vibe over by tx, ty, tz. that's the whole thing. slay.

✨ SYNOPSIS ✨

#include <volpack.h>

vpResult
vpTranslate(vpc, tx, ty, tz)
    vpContext *vpc;
    double *tx, *ty, *tz;

🎀 ARGUMENTS 🎀

• vpc — your VolPack context, the one you got from vpCreateContext. your main character, basically.
• tx — the X component of the translation vector.
• ty — the Y component of the translation vector.
• tz — the Z component of the translation vector.

💖 DESCRIPTION 💖

so vpTranslate multiplies the current transformation matrix by a 4-by-4 translation matrix. no cap, that's it. the translation matrix is giving:

 1   0   0  tx
 0   1   0  ty
 0   0   1  tz
 0   0   0   1

use vpCurrentMatrix to set the current transformation matrix — that's how you decide which matrix is the matrix, yk?

by default, the transformation matrix is post-multiplied (M = M*T where M is the current matrix and T is the translation matrix). and if you'd rather pre-multiply? the VP_CONCAT_MODE option to vpSeti can be used to select pre-multiplication. your math, your rules 💅

🫶 STATE VARIABLES 🫶

the current matrix concatenation parameters can be retrieved with the following state variable codes (see vpGeti(3)): VP_CURRENT_MATRIX, VP_CONCAT_MODE.

😭 ERRORS 😭

the return value is always VP_OK. like. it cannot fail. it woke up and chose success. periodt.

🔥 SEE ALSO 🔥

VolPack(3), vpCreateContext(3), vpCurrentMatrix(3)

and that's the tea bestie 🍓 go forth and translate. this page came to you from the VolPack manual — version vpTranslate(3) — mwah, love that for you 💜