historical/toontown-classic.git/panda/include/geomVertexArrayFormat.I

168 lines
4.6 KiB
Text
Raw Normal View History

2024-01-16 11:20:27 -06:00
/**
* PANDA 3D SOFTWARE
* Copyright (c) Carnegie Mellon University. All rights reserved.
*
* All use of this software is subject to the terms of the revised BSD
* license. You should have received a copy of this license along
* with this source code in a file named "LICENSE."
*
* @file geomVertexArrayFormat.I
* @author drose
* @date 2005-03-06
*/
/**
* Returns true if this format has been registered, false if it has not. It
* may not be used for a Geom until it has been registered, but once
* registered, it may no longer be modified.
*/
INLINE bool GeomVertexArrayFormat::
is_registered() const {
return _is_registered;
}
/**
* Adds the indicated format to the registry, if there is not an equivalent
* format already there; in either case, returns the pointer to the equivalent
* format now in the registry.
*
* This is similar to GeomVertexFormat::register_format(), except that you
* generally need not call it explicitly. Calling
* GeomVertexFormat::register_format() automatically registers all of the
* nested array formats.
*/
INLINE CPT(GeomVertexArrayFormat) GeomVertexArrayFormat::
register_format(const GeomVertexArrayFormat *format) {
return get_registry()->register_format((GeomVertexArrayFormat *)format);
}
/**
* Returns the total number of bytes reserved in the array for each vertex.
*/
INLINE int GeomVertexArrayFormat::
get_stride() const {
return _stride;
}
/**
* Changes the total number of bytes reserved in the array for each vertex.
* You may not reduce this below get_total_bytes(), but you may increase it
* arbitrarily.
*/
INLINE void GeomVertexArrayFormat::
set_stride(int stride) {
nassertv(!_is_registered);
nassertv(_stride >= _total_bytes);
_stride = stride;
}
/**
* Returns the byte divisor to which the data record must be padded to meet
* hardware limitations. For instance, if this is 4, the stride will be
* automatically rounded up to the next multiple of 4 bytes. This value is
* automatically increased as needed to ensure the individual numeric
* components in the array are word-aligned.
*/
INLINE int GeomVertexArrayFormat::
get_pad_to() const {
return _pad_to;
}
/**
* Explicitly sets the byte divisor to which the data record must be padded to
* meet hardware limitations. See get_pad_to(). Normally it is not necessary
* to call this unless you have some specific requirements for row-to-row data
* alignment. Note that this value may be automatically increased at each
* subsequent call to add_column().
*/
INLINE void GeomVertexArrayFormat::
set_pad_to(int pad_to) {
nassertv(pad_to >= 1);
_pad_to = pad_to;
_stride = ((_stride + _pad_to - 1) / _pad_to) * _pad_to;
}
/**
* Returns the divisor attribute for the data in this array. If 0, it
* contains per-vertex data. If 1, it contains per-instance data. If higher
* than 1, the read row is advanced for each n instances.
*/
INLINE int GeomVertexArrayFormat::
get_divisor() const {
return _divisor;
}
/**
* Set this to 0 to indicate that this array contains per-vertex data, or to 1
* to indicate that it contains per-instance data. If higher than 1, the read
* row is advanced for each n instances.
*/
INLINE void GeomVertexArrayFormat::
set_divisor(int divisor) {
nassertv(divisor >= 0);
_divisor = divisor;
}
/**
* Returns the total number of bytes used by the data types within the format,
* including gaps between elements.
*/
INLINE int GeomVertexArrayFormat::
get_total_bytes() const {
return _total_bytes;
}
/**
* Returns the number of different columns in the array.
*/
INLINE int GeomVertexArrayFormat::
get_num_columns() const {
return (int)_columns.size();
}
/**
* Returns the ith column of the array.
*/
INLINE const GeomVertexColumn *GeomVertexArrayFormat::
get_column(int i) const {
nassertr(i >= 0 && i < (int)_columns.size(), nullptr);
consider_sort_columns();
return _columns[(size_t)i];
}
/**
* Returns true if the array has the named column, false otherwise.
*/
INLINE bool GeomVertexArrayFormat::
has_column(const InternalName *name) const {
return (get_column(name) != nullptr);
}
/**
* Returns the global registry object.
*/
INLINE GeomVertexArrayFormat::Registry *GeomVertexArrayFormat::
get_registry() {
if (_registry == nullptr) {
make_registry();
}
return _registry;
}
/**
* Resorts the _columns vector if necessary.
*/
INLINE void GeomVertexArrayFormat::
consider_sort_columns() const {
if (_columns_unsorted) {
((GeomVertexArrayFormat *)this)->sort_columns();
}
}
INLINE std::ostream &
operator << (std::ostream &out, const GeomVertexArrayFormat &obj) {
obj.output(out);
return out;
}