A general bitmask class. More...

#include "bitMask.h"

Public Types
enum	{ num_bits = nbits }

typedef WType	WordType

Public Member Functions
constexpr	BitMask (WordType init_value)

bool	__nonzero__ () const
	Returns true if the bitmask is not zero.

void	clear ()
	Sets all the bits in the BitMask off.

void	clear_bit (int index)
	Sets the nth bit off.

void	clear_range (int low_bit, int size)
	Sets the indicated range of bits off.

int	compare_to (const BitMask< WType, nbits > &other) const
	Returns a number less than zero if this BitMask sorts before the indicated other BitMask, greater than zero if it sorts after, or 0 if they are equivalent.

WordType	extract (int low_bit, int size) const
	Returns a word that represents only the indicated range of bits within this BitMask, shifted to the least-significant position.

BitMask< WType, nbits >	flood_bits_down () const
	Returns a BitMask with the bits flooded down.

BitMask< WType, nbits >	flood_bits_up () const
	Returns a BitMask with the bits flooded upwards.

void	flood_down_in_place ()
	Floods this bitmask's bits downwards.

void	flood_up_in_place ()
	Floods this bitmask's bits upwards.

void	generate_hash (ChecksumHashGenerator &hashgen) const
	Adds the bitmask to the indicated hash generator.

bool	get_bit (int index) const
	Returns true if the nth bit is set, false if it is cleared.

int	get_highest_off_bit () const
	Returns the index of the highest 0 bit in the mask.

int	get_highest_on_bit () const
	Returns the index of the highest 1 bit in the mask.

int	get_key () const
	Returns a mostly unique integer key per unique bitmask, suitable for using in a hash table.

int	get_lowest_off_bit () const
	Returns the index of the lowest 0 bit in the mask.

int	get_lowest_on_bit () const
	Returns the index of the lowest 1 bit in the mask.

int	get_next_higher_different_bit (int low_bit) const
	Returns the index of the next bit in the mask, above low_bit, whose value is different that the value of low_bit.

constexpr int	get_num_bits () const
	Returns the number of bits available to set in the bitmask.

int	get_num_off_bits () const
	Returns the number of bits that are set to 0 in the mask.

int	get_num_on_bits () const
	Returns the number of bits that are set to 1 in the mask.

WordType	get_word () const
	Returns the entire BitMask as a single word.

bool	has_all_of (int low_bit, int size) const
	Returns true if all bits in the indicated range are set, false otherwise.

bool	has_any_of (int low_bit, int size) const
	Returns true if any bit in the indicated range is set, false otherwise.

bool	has_bits_in_common (const BitMask< WType, nbits > &other) const
	Returns true if this BitMask has any "one" bits in common with the other one, false otherwise.

void	invert_in_place ()
	Inverts all the bits in the BitMask.

bool	is_all_on () const
	Returns true if the entire bitmask is one, false otherwise.

bool	is_zero () const
	Returns true if the entire bitmask is zero, false otherwise.

BitMask< WType, nbits >	keep_next_highest_bit () const
	Returns a BitMask with only the next highest bit above the indicated bit on, or all_off.

BitMask< WType, nbits >	keep_next_highest_bit (const BitMask< WType, nbits > &other) const
	Returns a BitMask with only the next highest "on" bit above all "on" bits in the passed in bitmask, or all_off.

BitMask< WType, nbits >	keep_next_highest_bit (int index) const
	Returns a BitMask with only the next highest bit above the indicated bit on, or all.

BitMask< WType, nbits >	keep_next_lowest_bit () const
	Returns a BitMask with only the next lower bit below the indicated bit on, or all_off.

BitMask< WType, nbits >	keep_next_lowest_bit (const BitMask< WType, nbits > &other) const
	Returns a BitMask with only the next lowest "on" bit below all "on" bits in the passed in bitmask, or all_off.

BitMask< WType, nbits >	keep_next_lowest_bit (int index) const
	Returns a BitMask with only the next lower bit below the indicated bit on, or all_off.

bool	operator!= (const BitMask< WType, nbits > &other) const

BitMask< WType, nbits >	operator& (const BitMask< WType, nbits > &other) const

void	operator&= (const BitMask< WType, nbits > &other)

bool	operator< (const BitMask< WType, nbits > &other) const
	The ordering operator is of limited usefulness with a BitMask, however, it has a definition which places all unique BitMasks into a unique ordering.

BitMask< WType, nbits >	operator<< (int shift) const

void	operator<<= (int shift)

bool	operator== (const BitMask< WType, nbits > &other) const

BitMask< WType, nbits >	operator>> (int shift) const

void	operator>>= (int shift)

BitMask< WType, nbits >	operator^ (const BitMask< WType, nbits > &other) const

void	operator^= (const BitMask< WType, nbits > &other)

BitMask< WType, nbits >	operator\| (const BitMask< WType, nbits > &other) const

void	operator\|= (const BitMask< WType, nbits > &other)

BitMask< WType, nbits >	operator~ () const

void	output (std::ostream &out) const
	Writes the BitMask out as a binary or a hex number, according to the number of bits.

void	output_binary (std::ostream &out, int spaces_every=4) const
	Writes the BitMask out as a binary number, with spaces every four bits.

void	output_hex (std::ostream &out, int spaces_every=4) const
	Writes the BitMask out as a hexadecimal number, with spaces every four digits.

void	set_bit (int index)
	Sets the nth bit on.

void	set_bit_to (int index, bool value)
	Sets the nth bit either on or off, according to the indicated bool value.

void	set_range (int low_bit, int size)
	Sets the indicated range of bits on.

void	set_range_to (bool value, int low_bit, int size)
	Sets the indicated range of bits to either on or off.

void	set_word (WordType value)
	Sets the entire BitMask to the value indicated by the given word.

void	store (WordType value, int low_bit, int size)
	Stores the indicated word into the indicated range of bits with this BitMask.

void	write (std::ostream &out, int indent_level=0) const
	Writes the BitMask out as a binary or a hex number, according to the number of bits.

Static Public Member Functions
static BitMask< WType, nbits >	all_off ()
	Returns a BitMask whose bits are all off.

static BitMask< WType, nbits >	all_on ()
	Returns a BitMask whose bits are all on.

static BitMask< WType, nbits >	bit (int index)
	Returns a BitMask with only the indicated bit on.

static TypeHandle	get_class_type ()

static constexpr int	get_max_num_bits ()

static constexpr bool	has_max_num_bits ()

static void	init_type (const std::string &name)

static BitMask< WType, nbits >	lower_on (int on_bits)
	Returns a BitMask whose lower on_bits bits are on.

static BitMask< WType, nbits >	range (int low_bit, int size)
	Returns a BitMask whose size bits, beginning at low_bit, are on.

Detailed Description

template<class WType, int nbits>
class BitMask< WType, nbits >

A general bitmask class.

This stores an array of bits of some length that must fit within a given word of the indicated type. See also BitArray.

Definition at line 32 of file bitMask.h.

Member Typedef Documentation

◆ WordType

template<class WType, int nbits>

typedef WType BitMask< WType, nbits >::WordType

Definition at line 34 of file bitMask.h.

Member Enumeration Documentation

◆ anonymous enum

template<class WType, int nbits>

anonymous enum

Definition at line 37 of file bitMask.h.

Constructor & Destructor Documentation

◆ BitMask()

template<class WType, int nbits>

BitMask< WType, nbits >::BitMask ( WordType init_value )

inlineconstexpr

Definition at line 21 of file bitMask.I.

Member Function Documentation

◆ nonzero()

template<class WType, int nbits>

bool BitMask< WType, nbits >::__nonzero__ ( ) const

inline

Returns true if the bitmask is not zero.

Definition at line 630 of file bitMask.I.

◆ all_off()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::all_off ( )

inlinestatic

Returns a BitMask whose bits are all off.

Definition at line 42 of file bitMask.I.

Referenced by keep_next_highest_bit(), and keep_next_lowest_bit().

◆ all_on()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::all_on ( )

inlinestatic

Returns a BitMask whose bits are all on.

Definition at line 31 of file bitMask.I.

◆ bit()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::bit ( int index )

inlinestatic

Returns a BitMask with only the indicated bit on.

Definition at line 69 of file bitMask.I.

Referenced by keep_next_highest_bit(), and keep_next_lowest_bit().

◆ clear()

template<class WType, int nbits>

void BitMask< WType, nbits >::clear ( )

inline

Sets all the bits in the BitMask off.

Definition at line 394 of file bitMask.I.

◆ clear_bit()

template<class WType, int nbits>

void BitMask< WType, nbits >::clear_bit ( int index )

inline

Sets the nth bit off.

index must be in the range [0, num_bits).

Definition at line 128 of file bitMask.I.

Referenced by RenderState::adjust_all_priorities(), RenderState::compare_mask(), RenderState::compare_to(), RenderState::cull_callback(), RenderState::remove_attrib(), set_bit_to(), and RenderState::write_datagram().

◆ clear_range()

template<class WType, int nbits>

void BitMask< WType, nbits >::clear_range	(	int	low_bit,
		int	size )

inline

Sets the indicated range of bits off.

Definition at line 222 of file bitMask.I.

References range().

Referenced by set_range_to().

◆ compare_to()

template<class WType, int nbits>

int BitMask< WType, nbits >::compare_to ( const BitMask< WType, nbits > & other ) const

inline

Returns a number less than zero if this BitMask sorts before the indicated other BitMask, greater than zero if it sorts after, or 0 if they are equivalent.

This is based on the same ordering defined by operator <.

Definition at line 496 of file bitMask.I.

◆ extract()

template<class WType, int nbits>

BitMask< WType, nbits >::WordType BitMask< WType, nbits >::extract	(	int	low_bit,
		int	size ) const

inline

Returns a word that represents only the indicated range of bits within this BitMask, shifted to the least-significant position.

Definition at line 171 of file bitMask.I.

References lower_on().

Referenced by output_hex().

◆ flood_bits_down()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::flood_bits_down ( ) const

inline

Returns a BitMask with the bits flooded down.

Definition at line 685 of file bitMask.I.

References flood_bits_down().

Referenced by flood_bits_down().

◆ flood_bits_up()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::flood_bits_up ( ) const

inline

Returns a BitMask with the bits flooded upwards.

Definition at line 675 of file bitMask.I.

References flood_bits_up().

Referenced by flood_bits_up().

◆ flood_down_in_place()

template<class WType, int nbits>

void BitMask< WType, nbits >::flood_down_in_place ( )

inline

Floods this bitmask's bits downwards.

Definition at line 666 of file bitMask.I.

References flood_bits_down().

Referenced by keep_next_highest_bit(), and keep_next_lowest_bit().

◆ flood_up_in_place()

template<class WType, int nbits>

void BitMask< WType, nbits >::flood_up_in_place ( )

inline

Floods this bitmask's bits upwards.

Definition at line 657 of file bitMask.I.

References flood_bits_up().

Referenced by keep_next_highest_bit(), and keep_next_lowest_bit().

◆ generate_hash()

template<class WType, int nbits>

void BitMask< WType, nbits >::generate_hash ( ChecksumHashGenerator & hashgen ) const

inline

Adds the bitmask to the indicated hash generator.

Definition at line 639 of file bitMask.I.

References ChecksumHashGenerator::add_int().

◆ get_bit()

template<class WType, int nbits>

bool BitMask< WType, nbits >::get_bit ( int index ) const

inline

Returns true if the nth bit is set, false if it is cleared.

index must be in the range [0, num_bits).

Definition at line 108 of file bitMask.I.

Referenced by output_binary(), and ShaderAttrib::set_shader_auto().

◆ get_class_type()

template<class WType, int nbits>

static TypeHandle BitMask< WType, nbits >::get_class_type ( )

inlinestatic

Definition at line 138 of file bitMask.h.

◆ get_highest_off_bit()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_highest_off_bit ( ) const

inline

Returns the index of the highest 0 bit in the mask.

Returns -1 if there are no 0 bits.

Definition at line 312 of file bitMask.I.

◆ get_highest_on_bit()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_highest_on_bit ( ) const

inline

Returns the index of the highest 1 bit in the mask.

Returns -1 if there are no 1 bits.

Definition at line 302 of file bitMask.I.

Referenced by keep_next_highest_bit().

◆ get_key()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_key ( ) const

inline

Returns a mostly unique integer key per unique bitmask, suitable for using in a hash table.

Definition at line 621 of file bitMask.I.

◆ get_lowest_off_bit()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_lowest_off_bit ( ) const

inline

Returns the index of the lowest 0 bit in the mask.

Returns -1 if there are no 0 bits.

Definition at line 292 of file bitMask.I.

◆ get_lowest_on_bit()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_lowest_on_bit ( ) const

inline

Returns the index of the lowest 1 bit in the mask.

Returns -1 if there are no 1 bits.

Definition at line 282 of file bitMask.I.

Referenced by RenderState::adjust_all_priorities(), RenderState::compare_mask(), RenderState::compare_to(), RenderState::cull_callback(), keep_next_lowest_bit(), and RenderState::write_datagram().

◆ get_max_num_bits()

template<class WType, int nbits>

static constexpr int BitMask< WType, nbits >::get_max_num_bits ( )

inlinestaticconstexpr

Definition at line 49 of file bitMask.h.

◆ get_next_higher_different_bit()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_next_higher_different_bit ( int low_bit ) const

inline

Returns the index of the next bit in the mask, above low_bit, whose value is different that the value of low_bit.

Returns low_bit again if all bits higher than low_bit have the same value.

This can be used to quickly iterate through all of the bits in the mask.

Definition at line 325 of file bitMask.I.

References count_bits_in_word().

◆ get_num_bits()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_num_bits ( ) const

constexpr

Returns the number of bits available to set in the bitmask.

Definition at line 98 of file bitMask.I.

◆ get_num_off_bits()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_num_off_bits ( ) const

inline

Returns the number of bits that are set to 0 in the mask.

Definition at line 272 of file bitMask.I.

References count_bits_in_word().

◆ get_num_on_bits()

template<class WType, int nbits>

int BitMask< WType, nbits >::get_num_on_bits ( ) const

inline

Returns the number of bits that are set to 1 in the mask.

Definition at line 263 of file bitMask.I.

References count_bits_in_word().

◆ get_word()

template<class WType, int nbits>

BitMask< WType, nbits >::WordType BitMask< WType, nbits >::get_word ( ) const

inline

Returns the entire BitMask as a single word.

Definition at line 245 of file bitMask.I.

◆ has_all_of()

template<class WType, int nbits>

bool BitMask< WType, nbits >::has_all_of	(	int	low_bit,
		int	size ) const

inline

Returns true if all bits in the indicated range are set, false otherwise.

Definition at line 202 of file bitMask.I.

References range().

◆ has_any_of()

template<class WType, int nbits>

bool BitMask< WType, nbits >::has_any_of	(	int	low_bit,
		int	size ) const

inline

Returns true if any bit in the indicated range is set, false otherwise.

Definition at line 192 of file bitMask.I.

References range().

◆ has_bits_in_common()

template<class WType, int nbits>

bool BitMask< WType, nbits >::has_bits_in_common ( const BitMask< WType, nbits > & other ) const

inline

Returns true if this BitMask has any "one" bits in common with the other one, false otherwise.

This is equivalent to (mask & other) != 0, but may be faster. (Actually, it should only be faster in the BitArray case, but this method is provided for the benefit of generic programming algorithms).

Definition at line 385 of file bitMask.I.

◆ has_max_num_bits()

template<class WType, int nbits>

static constexpr bool BitMask< WType, nbits >::has_max_num_bits ( )

inlinestaticconstexpr

Definition at line 48 of file bitMask.h.

◆ init_type()

template<class WType, int nbits>

void BitMask< WType, nbits >::init_type ( const std::string & name )

static

Definition at line 648 of file bitMask.I.

◆ invert_in_place()

template<class WType, int nbits>

void BitMask< WType, nbits >::invert_in_place ( )

inline

Inverts all the bits in the BitMask.

This is equivalent to mask = ~mask.

Definition at line 371 of file bitMask.I.

Referenced by keep_next_highest_bit(), and keep_next_lowest_bit().

◆ is_all_on()

template<class WType, int nbits>

bool BitMask< WType, nbits >::is_all_on ( ) const

inline

Returns true if the entire bitmask is one, false otherwise.

Definition at line 161 of file bitMask.I.

◆ is_zero()

template<class WType, int nbits>

bool BitMask< WType, nbits >::is_zero ( ) const

inline

Returns true if the entire bitmask is zero, false otherwise.

Definition at line 152 of file bitMask.I.

Referenced by PandaNode::adjust_draw_mask().

◆ keep_next_highest_bit() [1/3]

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::keep_next_highest_bit ( ) const

inline

Returns a BitMask with only the next highest bit above the indicated bit on, or all_off.

Definition at line 697 of file bitMask.I.

References all_off(), bit(), and get_lowest_on_bit().

Referenced by keep_next_highest_bit().

◆ keep_next_highest_bit() [2/3]

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::keep_next_highest_bit ( const BitMask< WType, nbits > & other ) const

inline

Returns a BitMask with only the next highest "on" bit above all "on" bits in the passed in bitmask, or all_off.

If there are no "on" bits in the passed in bitmask, it will return keep_next_highest_bit().

Definition at line 776 of file bitMask.I.

References get_highest_on_bit(), and keep_next_highest_bit().

◆ keep_next_highest_bit() [3/3]

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::keep_next_highest_bit ( int index ) const

inline

Returns a BitMask with only the next highest bit above the indicated bit on, or all.

Definition at line 727 of file bitMask.I.

References flood_down_in_place(), flood_up_in_place(), invert_in_place(), and set_bit().

◆ keep_next_lowest_bit() [1/3]

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::keep_next_lowest_bit ( ) const

inline

Returns a BitMask with only the next lower bit below the indicated bit on, or all_off.

Definition at line 712 of file bitMask.I.

References all_off(), bit(), and get_highest_on_bit().

Referenced by keep_next_lowest_bit().

◆ keep_next_lowest_bit() [2/3]

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::keep_next_lowest_bit ( const BitMask< WType, nbits > & other ) const

inline

Returns a BitMask with only the next lowest "on" bit below all "on" bits in the passed in bitmask, or all_off.

If there are no "on" bits in the passed in bitmask, it will return keep_next_lowest_bit().

Definition at line 792 of file bitMask.I.

References get_lowest_on_bit(), and keep_next_lowest_bit().

◆ keep_next_lowest_bit() [3/3]

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::keep_next_lowest_bit ( int index ) const

inline

Returns a BitMask with only the next lower bit below the indicated bit on, or all_off.

Definition at line 751 of file bitMask.I.

References flood_down_in_place(), flood_up_in_place(), invert_in_place(), and set_bit().

◆ lower_on()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::lower_on ( int on_bits )

inlinestatic

Returns a BitMask whose lower on_bits bits are on.

Definition at line 53 of file bitMask.I.

Referenced by extract().

◆ operator!=()

template<class WType, int nbits>

bool BitMask< WType, nbits >::operator!= ( const BitMask< WType, nbits > & other ) const

inline

Definition at line 472 of file bitMask.I.

◆ operator&()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::operator& ( const BitMask< WType, nbits > & other ) const

inline

Definition at line 511 of file bitMask.I.

◆ operator&=()

template<class WType, int nbits>

void BitMask< WType, nbits >::operator&= ( const BitMask< WType, nbits > & other )

inline

Definition at line 575 of file bitMask.I.

◆ operator<()

template<class WType, int nbits>

bool BitMask< WType, nbits >::operator< ( const BitMask< WType, nbits > & other ) const

inline

The ordering operator is of limited usefulness with a BitMask, however, it has a definition which places all unique BitMasks into a unique ordering.

It may be useful when defining ordered STL containers of BitMasks, for instance; and it's required in order to export any STL container (ordered or unordered) of BitMask under Windows.

Definition at line 485 of file bitMask.I.

◆ operator<<()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::operator<< ( int shift ) const

inline

Definition at line 544 of file bitMask.I.

◆ operator<<=()

template<class WType, int nbits>

void BitMask< WType, nbits >::operator<<= ( int shift )

inline

Definition at line 602 of file bitMask.I.

◆ operator==()

template<class WType, int nbits>

bool BitMask< WType, nbits >::operator== ( const BitMask< WType, nbits > & other ) const

inline

Definition at line 463 of file bitMask.I.

◆ operator>>()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::operator>> ( int shift ) const

inline

Definition at line 564 of file bitMask.I.

◆ operator>>=()

template<class WType, int nbits>

void BitMask< WType, nbits >::operator>>= ( int shift )

inline

Definition at line 611 of file bitMask.I.

◆ operator^()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::operator^ ( const BitMask< WType, nbits > & other ) const

inline

Definition at line 533 of file bitMask.I.

◆ operator^=()

template<class WType, int nbits>

void BitMask< WType, nbits >::operator^= ( const BitMask< WType, nbits > & other )

inline

Definition at line 593 of file bitMask.I.

◆ operator|()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::operator| ( const BitMask< WType, nbits > & other ) const

inline

Definition at line 522 of file bitMask.I.

◆ operator|=()

template<class WType, int nbits>

void BitMask< WType, nbits >::operator|= ( const BitMask< WType, nbits > & other )

inline

Definition at line 584 of file bitMask.I.

◆ operator~()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::operator~ ( ) const

inline

Definition at line 544 of file bitMask.I.

◆ output()

template<class WType, int nbits>

void BitMask< WType, nbits >::output ( std::ostream & out ) const

Writes the BitMask out as a binary or a hex number, according to the number of bits.

Definition at line 404 of file bitMask.I.

References output_binary(), and output_hex().

◆ output_binary()

template<class WType, int nbits>

void BitMask< WType, nbits >::output_binary	(	std::ostream &	out,
		int	spaces_every = 4 ) const

Writes the BitMask out as a binary number, with spaces every four bits.

Definition at line 417 of file bitMask.I.

References get_bit().

Referenced by output().

◆ output_hex()

template<class WType, int nbits>

void BitMask< WType, nbits >::output_hex	(	std::ostream &	out,
		int	spaces_every = 4 ) const

Writes the BitMask out as a hexadecimal number, with spaces every four digits.

Definition at line 432 of file bitMask.I.

References extract().

Referenced by output().

◆ range()

template<class WType, int nbits>

BitMask< WType, nbits > BitMask< WType, nbits >::range	(	int	low_bit,
		int	size )

inlinestatic

Returns a BitMask whose size bits, beginning at low_bit, are on.

Definition at line 80 of file bitMask.I.

Referenced by clear_range(), has_all_of(), has_any_of(), set_range(), and store().

◆ set_bit()

template<class WType, int nbits>

void BitMask< WType, nbits >::set_bit ( int index )

inline

Sets the nth bit on.

index must be in the range [0, num_bits).

Definition at line 118 of file bitMask.I.

Referenced by RenderState::add_attrib(), keep_next_highest_bit(), keep_next_lowest_bit(), RenderState::make(), RenderState::make(), RenderState::make(), RenderState::make(), RenderState::make(), RenderState::make(), RenderState::set_attrib(), RenderState::set_attrib(), and set_bit_to().

◆ set_bit_to()

template<class WType, int nbits>

void BitMask< WType, nbits >::set_bit_to	(	int	index,
		bool	value )

inline

Sets the nth bit either on or off, according to the indicated bool value.

index must be in the range [0, num_bits).

Definition at line 139 of file bitMask.I.

References clear_bit(), and set_bit().

◆ set_range()

template<class WType, int nbits>

void BitMask< WType, nbits >::set_range	(	int	low_bit,
		int	size )

inline

Sets the indicated range of bits on.

Definition at line 212 of file bitMask.I.

References range().

Referenced by set_range_to().

◆ set_range_to()

template<class WType, int nbits>

void BitMask< WType, nbits >::set_range_to	(	bool	value,
		int	low_bit,
		int	size )

inline

Sets the indicated range of bits to either on or off.

Definition at line 232 of file bitMask.I.

References clear_range(), and set_range().

◆ set_word()

template<class WType, int nbits>

void BitMask< WType, nbits >::set_word ( WordType value )

inline

Sets the entire BitMask to the value indicated by the given word.

Definition at line 254 of file bitMask.I.

◆ store()

template<class WType, int nbits>

void BitMask< WType, nbits >::store	(	WordType	value,
		int	low_bit,
		int	size )

inline

Stores the indicated word into the indicated range of bits with this BitMask.

Definition at line 182 of file bitMask.I.

References range().

◆ write()

template<class WType, int nbits>

void BitMask< WType, nbits >::write	(	std::ostream &	out,
		int	indent_level = 0 ) const

Writes the BitMask out as a binary or a hex number, according to the number of bits.

Definition at line 454 of file bitMask.I.

References indent().

The documentation for this class was generated from the following files:

panda/src/putil/bitMask.h
panda/src/putil/bitMask.I

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ WordType

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ BitMask()

Member Function Documentation

◆ __nonzero__()

◆ all_off()

◆ all_on()

◆ bit()

◆ clear()

◆ clear_bit()

◆ clear_range()

◆ compare_to()

◆ extract()

◆ flood_bits_down()

◆ flood_bits_up()

◆ flood_down_in_place()

◆ flood_up_in_place()

◆ generate_hash()

◆ get_bit()

◆ get_class_type()

◆ get_highest_off_bit()

◆ get_highest_on_bit()

◆ get_key()

◆ get_lowest_off_bit()

◆ get_lowest_on_bit()

◆ get_max_num_bits()

◆ get_next_higher_different_bit()

◆ get_num_bits()

◆ get_num_off_bits()

◆ get_num_on_bits()

◆ get_word()

◆ has_all_of()

◆ has_any_of()

◆ has_bits_in_common()

◆ has_max_num_bits()

◆ init_type()

◆ invert_in_place()

◆ is_all_on()

◆ is_zero()

◆ keep_next_highest_bit() [1/3]

◆ keep_next_highest_bit() [2/3]

◆ keep_next_highest_bit() [3/3]

◆ keep_next_lowest_bit() [1/3]

◆ keep_next_lowest_bit() [2/3]

◆ keep_next_lowest_bit() [3/3]

◆ lower_on()

◆ operator!=()

◆ operator&()

◆ operator&=()

◆ operator<()

◆ operator<<()

◆ operator<<=()

◆ operator==()

◆ operator>>()

◆ operator>>=()

◆ operator^()

◆ operator^=()

◆ operator|()

◆ operator|=()

◆ operator~()

◆ output()

◆ output_binary()

◆ output_hex()

◆ range()

◆ set_bit()

◆ set_bit_to()

◆ set_range()

◆ set_range_to()

◆ set_word()

◆ store()

◆ write()

◆ nonzero()