vpEnable(3)

πŸ“¦ version 1.0c7, in fedora 43, fedora 44

πŸ’… vpEnable(3) β€” Library Functions Manual ✨

okay bestie, welcome to the Library Functions Manual section for vpEnable, and honestly? she's a little toggle queen and you're gonna love her πŸŽ€


✨ NAME ✨

vpEnable β€” turn options on or off, that's it, that's the whole job πŸ’–


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <volpack.h>

vpResult
vpEnable(vpc, option, value)
    vpContext *vpc;
    int option;
    int value;

🌸 ARGUMENTS 🌸

  • vpc β€” the VolPack context you got from vpCreateContext. your main character, fr.
  • option β€” a constant that says which option is getting adjusted. pick your fighter πŸ’…
  • value β€” the new value for the option, and it's boolean so it's literally just 0 or 1.

πŸ‘‘ DESCRIPTION πŸ‘‘

so like, vpEnable is the girl who flips boolean options on and off inside a rendering context. if value is 0, the option gets disabled. otherwise (any other value, not just 1, iykyk) it gets enabled. periodt.

here's the whole squad of options, no cap, every single one:

  • VP_LIGHT0
  • VP_LIGHT1
  • VP_LIGHT2
  • VP_LIGHT3
  • VP_LIGHT4
  • VP_LIGHT5

turns on the corresponding light source (peep vpSetLight(3)). Default: VP_LIGHT0 is enabled, and all the others are disabled. she's the favorite child, we don't make the rules πŸ’€

  • VP_LIGHT_BOTH_SIDES β€” enables two-sided lighting (again, vpSetLight(3)). Default: disabled
  • VP_REVERSE_SURFACE_SIDES β€” flips the definition of interior and exterior surfaces (see vpSetMaterial(3)). Default: disabled
  • VP_DEPTH_CUE β€” enables depth cueing (see vpSetDepthCueing(3)). Default: disabled
  • VP_VIEW_X_AXIS
  • VP_VIEW_Y_AXIS
  • VP_VIEW_Z_AXIS

enables computing a preclassified volume for the corresponding major viewing axis (see vpClassifyVolume(3)). Default: enabled

  • VP_SHADOW β€” enables rendering shadows (see vpSetShadowLookupShader(3)). Default: disabled
  • VP_CLAMP_SHADE_TABLE β€” enables clamping the color components in a shade table to the range 0.0-255.0. this option affects vpShadeTable(). Default: enabled

😭 ERRORS 😭

the normal return value is VP_OK. that's the slay outcome 🫢

but sometimes things go wrong, and the following error return value is possible:

  • VPERROR_BAD_VALUE β€” the option argument is invalid. like girl, that's not a real option, who is she πŸ™ˆ

🌈 SEE ALSO 🌈

VolPack(3), vpCreateContext(3)


okay that's the whole page, you ate it, go enable some stuff bestie πŸ’œ

this was the VolPack release, dated vpEnable(3) in the footer, mwah πŸ’‹ no notes, iconic, bye βœ¨πŸŽ€

πŸ“¦ where this page comes from